├── .github ├── .gitignore └── workflows │ └── CRAN check and test.yaml ├── .gitignore ├── .Rbuildignore ├── tests ├── testthat.R ├── files │ ├── PlotDataFrame.RDS │ ├── PlotDataFrameCI.RDS │ ├── PlotDataFrameOR.RDS │ ├── jss_texreg_gls.RDS │ ├── jss_htmlreg_word.RDS │ ├── jss_screenreg_lm.RDS │ ├── jss_texreg_robust.RDS │ ├── jss_htmlreg_markdown.RDS │ ├── jss_texreg_dcolumn_booktabs.RDS │ └── jss_texreg_bold_customnote_digits.RDS └── testthat │ ├── test-huxtablereg.R │ ├── test-praise.R │ ├── test-plotreg.R │ └── test-jss.R ├── man ├── print.texregTable.Rd ├── extract-texreg-method.Rd ├── extract-coeftest-method.Rd ├── extract-ANY-method.Rd ├── extract-forecast-method.Rd ├── extract-pmg-method.Rd ├── extract-rlm-method.Rd ├── extract-ergmm-method.Rd ├── extract-glmrob-method.Rd ├── extract-sienaFit-method.Rd ├── extract-rq-method.Rd ├── extract-maxLik-method.Rd ├── reorder.Rd ├── extract-simex-method.Rd ├── extract-btergm-method.Rd ├── extract-mhurdle-method.Rd ├── show-texreg-method.Rd ├── extract-bergm-method.Rd ├── names2latex.Rd ├── extract-averaging-method.Rd ├── extract-pgmm-method.Rd ├── extract-gee-method.Rd ├── extract-lrm-method.Rd ├── extract-betaor-method.Rd ├── extract-betamfx-method.Rd ├── extract-biglm-method.Rd ├── extract-geeglm-method.Rd ├── extract-prais-method.Rd ├── extract-fGARCH-method.Rd ├── extract-vglm-method.Rd ├── texreg-package.Rd ├── extract-pglm-method.Rd ├── extract-bife-method.Rd ├── extract-ergm-method.Rd ├── extract-pcce-method.Rd ├── extract-feglm-method.Rd ├── extract-plm-method.Rd ├── extract-wls-method.Rd ├── extract-gmm-method.Rd ├── extract-netlogit-method.Rd ├── extract-gamlssZadj-method.Rd ├── get.data.Rd ├── extract-betareg-method.Rd ├── extract-logitr-method.Rd ├── extract-ols-method.Rd ├── extract-gls-method.Rd ├── extract-mtergm-method.Rd ├── extract-gnls-method.Rd ├── extract-truncreg-method.Rd ├── extract-censReg-method.Rd ├── extract-ets-method.Rd ├── extract-gamlss-method.Rd ├── extract-Arima-method.Rd ├── extract-oglmx-method.Rd ├── extract-lnam-method.Rd ├── extract-logitor-method.Rd ├── extract-Sarlm-method.Rd ├── extract-glm-method.Rd ├── extract-logitmfx-method.Rd ├── extract-lm-method.Rd ├── extract-negbinirr-method.Rd ├── extract-negbinmfx-method.Rd ├── extract-probitmfx-method.Rd ├── extract-brglm-method.Rd ├── extract-model.selection-method.Rd ├── extract-poissonirr-method.Rd ├── extract-poissonmfx-method.Rd ├── extract-rem.dyad-method.Rd ├── extract-negbin-method.Rd ├── coeftostring.Rd ├── extract-clm-method.Rd ├── extract-dynlm-method.Rd ├── extract-gel-method.Rd ├── extract-ivreg-method.Rd ├── extract-sclm-method.Rd ├── extract-survreg-method.Rd ├── extract-speedglm-method.Rd ├── extract-feis-method.Rd ├── extract-speedlm-method.Rd ├── extract-phreg-method.Rd ├── extract-aftreg-method.Rd ├── extract-coxreg-method.Rd ├── extract-survreg.penal-method.Rd ├── extract-lmrob-method.Rd ├── extract-summary.lm-method.Rd ├── extract-weibreg-method.Rd ├── extract-lme-method.Rd ├── extract-lm.cluster-method.Rd ├── extract-systemfit-method.Rd ├── extract-glm.cluster-method.Rd ├── extract-nlme-method.Rd ├── extract-polr-method.Rd ├── extract-svyglm-method.Rd ├── extract-glmmPQL-method.Rd ├── extract-forecast_ARIMA-method.Rd ├── extract-clogit-method.Rd ├── extract-felm-method.Rd ├── extract-clmm-method.Rd ├── extract-remstimate-method.Rd ├── extract-mlogit-method.Rd ├── extract-gnm-method.Rd ├── extract-coxph-method.Rd ├── extract-tobit-method.Rd ├── extract-coxph.penal-method.Rd ├── extract-lqmm-method.Rd ├── extract-hurdle-method.Rd ├── extract-zeroinfl-method.Rd ├── extract-glmmadmb-method.Rd ├── extract-H2OBinomialModel-method.Rd ├── texreg-class.Rd ├── extract-stergm-method.Rd ├── get_stars_note.Rd ├── extract-fixest-method.Rd ├── extract-multinom-method.Rd ├── customcolumnnames.Rd ├── override.Rd ├── extract-glmmTMB-method.Rd ├── compute.width.Rd ├── extract-selection-method.Rd ├── extract-bam-method.Rd ├── extract-gam-method.Rd ├── extract-brmsfit-method.Rd ├── extract-lme4-method.Rd ├── extract-merMod-method.Rd ├── extract-lmerMod-method.Rd ├── extract-glmerMod-method.Rd ├── extract-nlmerMod-method.Rd ├── extract.Rd ├── knitreg.Rd ├── createTexreg.Rd └── praise.Rd ├── texreg.Rproj ├── inst └── CITATION ├── NAMESPACE ├── DESCRIPTION └── README.md /.github/.gitignore: -------------------------------------------------------------------------------- 1 | *.html 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *.Rhistory 3 | .Rproj.user 4 | -------------------------------------------------------------------------------- /.Rbuildignore: -------------------------------------------------------------------------------- 1 | README.md 2 | ^.*\.Rproj$ 3 | ^\.Rproj\.user$ 4 | ^\.github$ 5 | -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library("testthat") 2 | library("texreg") 3 | 4 | test_check("texreg") 5 | -------------------------------------------------------------------------------- /tests/files/PlotDataFrame.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/PlotDataFrame.RDS -------------------------------------------------------------------------------- /tests/files/PlotDataFrameCI.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/PlotDataFrameCI.RDS -------------------------------------------------------------------------------- /tests/files/PlotDataFrameOR.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/PlotDataFrameOR.RDS -------------------------------------------------------------------------------- /tests/files/jss_texreg_gls.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/jss_texreg_gls.RDS -------------------------------------------------------------------------------- /tests/files/jss_htmlreg_word.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/jss_htmlreg_word.RDS -------------------------------------------------------------------------------- /tests/files/jss_screenreg_lm.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/jss_screenreg_lm.RDS -------------------------------------------------------------------------------- /tests/files/jss_texreg_robust.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/jss_texreg_robust.RDS -------------------------------------------------------------------------------- /tests/files/jss_htmlreg_markdown.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/jss_htmlreg_markdown.RDS -------------------------------------------------------------------------------- /tests/files/jss_texreg_dcolumn_booktabs.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/jss_texreg_dcolumn_booktabs.RDS -------------------------------------------------------------------------------- /tests/files/jss_texreg_bold_customnote_digits.RDS: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/leifeld/texreg/HEAD/tests/files/jss_texreg_bold_customnote_digits.RDS -------------------------------------------------------------------------------- /man/print.texregTable.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{print.texregTable} 4 | \alias{print.texregTable} 5 | \title{Prints a \code{texregTable} object.} 6 | \usage{ 7 | \method{print}{texregTable}(x, ...) 8 | } 9 | \arguments{ 10 | \item{x}{A \code{texregTable} argument, as produced by \code{\link{texreg}} 11 | and related functions.} 12 | 13 | \item{...}{Additional arguments for the \code{\link[base]{cat}} function.} 14 | } 15 | \description{ 16 | Prints a \code{texregTable} object. 17 | } 18 | \author{ 19 | Philip Leifeld 20 | } 21 | -------------------------------------------------------------------------------- /texreg.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | ProjectId: 168cfada-eb01-4d33-a891-d0ec0a45a338 3 | 4 | RestoreWorkspace: Default 5 | SaveWorkspace: Default 6 | AlwaysSaveHistory: Default 7 | 8 | EnableCodeIndexing: Yes 9 | UseSpacesForTab: Yes 10 | NumSpacesForTab: 2 11 | Encoding: UTF-8 12 | 13 | RnwWeave: Sweave 14 | LaTeX: pdfLaTeX 15 | 16 | StripTrailingWhitespace: Yes 17 | 18 | BuildType: Package 19 | PackageUseDevtools: Yes 20 | PackageInstallArgs: --no-multiarch --with-keep.source 21 | PackageBuildArgs: --compact-vignettes=gs+qpdf 22 | PackageCheckArgs: --as-cran 23 | PackageRoxygenize: rd,collate,namespace 24 | -------------------------------------------------------------------------------- /man/extract-texreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,texreg-method} 4 | \alias{extract,texreg-method} 5 | \alias{extract.texreg} 6 | \title{\code{\link{extract}} method for \code{texreg} objects} 7 | \usage{ 8 | \S4method{extract}{texreg}(model, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 14 | not in use.} 15 | } 16 | \description{ 17 | \code{\link{extract}} method for \code{texreg} objects created by the 18 | \code{\link[texreg]{extract}} function in the \pkg{texreg} package. 19 | } 20 | -------------------------------------------------------------------------------- /man/extract-coeftest-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,coeftest-method} 4 | \alias{extract,coeftest-method} 5 | \alias{extract.coeftest} 6 | \title{\code{\link{extract}} method for \code{coeftest} objects} 7 | \usage{ 8 | \S4method{extract}{coeftest}(model, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 14 | not in use.} 15 | } 16 | \description{ 17 | \code{\link{extract}} method for \code{coeftest} objects created by the 18 | \code{\link[lmtest]{coeftest}} function in the \pkg{lmtest} package. 19 | } 20 | -------------------------------------------------------------------------------- /inst/CITATION: -------------------------------------------------------------------------------- 1 | citHeader("To cite texreg in publications use:") 2 | 3 | bibentry(bibtype = "Article", 4 | title = "{texreg}: Conversion of Statistical Model Output in {R} to {\\LaTeX} and {HTML} Tables", 5 | author = person(given = "Philip", family = "Leifeld"), 6 | journal = "Journal of Statistical Software", 7 | year = 2013, 8 | volume = "55", 9 | number = "8", 10 | pages = "1--24", 11 | url = "https://doi.org/10.18637/jss.v055.i08", 12 | textVersion = paste("Leifeld, Philip (2013).", 13 | "texreg: Conversion of Statistical Model Output in R to LaTeX and HTML Tables.", 14 | "Journal of Statistical Software, 55(8), 1-24.", 15 | "URL https://doi.org/10.18637/jss.v055.i08") 16 | ) 17 | -------------------------------------------------------------------------------- /man/extract-ANY-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,ANY-method} 4 | \alias{extract,ANY-method} 5 | \alias{extract.broom} 6 | \alias{extract.ANY} 7 | \alias{extract.ANY-method} 8 | \title{\code{\link{extract}} method for \code{broom} objects} 9 | \usage{ 10 | \S4method{extract}{ANY}(model, ...) 11 | } 12 | \arguments{ 13 | \item{model}{A statistical model object.} 14 | 15 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 16 | not in use.} 17 | } 18 | \description{ 19 | \code{\link{extract}} method for \code{broom} objects created by the 20 | \code{\link[broom]{broom}} function in the \pkg{broom} package. 21 | } 22 | -------------------------------------------------------------------------------- /man/extract-forecast-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,forecast-method} 4 | \alias{extract,forecast-method} 5 | \alias{extract.forecast} 6 | \title{\code{\link{extract}} method for \code{forecast} objects} 7 | \usage{ 8 | \S4method{extract}{forecast}(model, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 14 | not in use.} 15 | } 16 | \description{ 17 | \code{\link{extract}} method for \code{forecast} objects created by the 18 | \code{\link[forecast]{forecast}} and \code{\link[forecast:ses]{holt}} functions 19 | in the \pkg{forecast} package. 20 | } 21 | -------------------------------------------------------------------------------- /man/extract-pmg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,pmg-method} 4 | \alias{extract,pmg-method} 5 | \alias{extract.pmg} 6 | \title{\code{\link{extract}} method for \code{pmg} objects} 7 | \usage{ 8 | \S4method{extract}{pmg}(model, include.nobs = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.nobs}{Report the number of observations in the GOF block?} 14 | 15 | \item{...}{Custom parameters, which are handed over to subroutines, in this 16 | case to the \code{summary} method for the object.} 17 | } 18 | \description{ 19 | \code{\link{extract}} method for \code{pmg} objects created by the 20 | \code{\link[plm]{pmg}} function in the \pkg{plm} package. 21 | } 22 | -------------------------------------------------------------------------------- /man/extract-rlm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,rlm-method} 4 | \alias{extract,rlm-method} 5 | \alias{extract.rlm} 6 | \title{\code{\link{extract}} method for \code{rlm} objects} 7 | \usage{ 8 | \S4method{extract}{rlm}(model, include.nobs = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.nobs}{Report the number of observations in the GOF block?} 14 | 15 | \item{...}{Custom parameters, which are handed over to subroutines, in this 16 | case to the \code{summary} method for the object.} 17 | } 18 | \description{ 19 | \code{\link{extract}} method for \code{rlm} objects created by the 20 | \code{\link[MASS]{rlm}} function in the \pkg{MASS} package. 21 | } 22 | -------------------------------------------------------------------------------- /man/extract-ergmm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,ergmm-method} 4 | \alias{extract,ergmm-method} 5 | \alias{extract.ergmm} 6 | \title{\code{\link{extract}} method for \code{ergmm} objects} 7 | \usage{ 8 | \S4method{extract}{ergmm}(model, include.bic = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 14 | block?} 15 | 16 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 17 | not in use.} 18 | } 19 | \description{ 20 | \code{\link{extract}} method for \code{ergmm} objects created by the 21 | \code{\link[latentnet]{ergmm}} function in the \pkg{latentnet} 22 | package. 23 | } 24 | -------------------------------------------------------------------------------- /man/extract-glmrob-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,glmrob-method} 4 | \alias{extract,glmrob-method} 5 | \alias{extract.glmrob} 6 | \title{\code{\link{extract}} method for \code{glmrob} objects} 7 | \usage{ 8 | \S4method{extract}{glmrob}(model, include.nobs = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.nobs}{Report the number of observations in the GOF block?} 14 | 15 | \item{...}{Custom parameters, which are handed over to subroutines, in this 16 | case to the \code{summary} method for the object.} 17 | } 18 | \description{ 19 | \code{\link{extract}} method for \code{glmrob} objects created by the 20 | \code{glmrob} function in the \pkg{robustbase} package. 21 | } 22 | -------------------------------------------------------------------------------- /man/extract-sienaFit-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,sienaFit-method} 4 | \alias{extract,sienaFit-method} 5 | \alias{extract.sienaFit} 6 | \title{\code{\link{extract}} method for \code{sienaFit} objects} 7 | \usage{ 8 | \S4method{extract}{sienaFit}(model, include.iterations = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.iterations}{Report the number of iterations?} 14 | 15 | \item{...}{Custom parameters, which are handed over to subroutines, in this 16 | case to the \code{summary} method for the object.} 17 | } 18 | \description{ 19 | \code{\link{extract}} method for \code{sienaFit} objects created by the 20 | \code{siena07} function in the \pkg{RSiena} package. 21 | } 22 | -------------------------------------------------------------------------------- /man/extract-rq-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,rq-method} 4 | \alias{extract,rq-method} 5 | \alias{extract.rq} 6 | \title{\code{\link{extract}} method for \code{rq} objects} 7 | \usage{ 8 | \S4method{extract}{rq}(model, include.nobs = TRUE, include.percentile = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.nobs}{Report the number of observations in the GOF block?} 14 | 15 | \item{include.percentile}{Report the percentile (tau)?} 16 | 17 | \item{...}{Custom parameters, which are handed over to subroutines, in this 18 | case to the \code{summary} method for the object.} 19 | } 20 | \description{ 21 | \code{\link{extract}} method for \code{rq} objects created by the 22 | \code{rq} function in the \pkg{quantreg} package. 23 | } 24 | -------------------------------------------------------------------------------- /man/extract-maxLik-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,maxLik-method} 4 | \alias{extract,maxLik-method} 5 | \alias{extract.maxLik} 6 | \title{\code{\link{extract}} method for \code{maxLik} objects} 7 | \usage{ 8 | \S4method{extract}{maxLik}(model, include.loglik = TRUE, include.aic = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.loglik}{Report the log likelihood in the GOF block?} 14 | 15 | \item{include.aic}{Report the AIC in the GOF block?} 16 | 17 | \item{...}{Custom parameters, which are handed over to subroutines, in this 18 | case to the \code{summary} method for the object.} 19 | } 20 | \description{ 21 | \code{\link{extract}} method for \code{maxLik} objects created by the 22 | \code{\link[maxLik]{maxLik}} function in the \pkg{maxLik} package. 23 | } 24 | -------------------------------------------------------------------------------- /man/reorder.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{reorder} 4 | \alias{reorder} 5 | \title{Reorder a matrix vertically according to a vector of new positions} 6 | \usage{ 7 | reorder(mat, new.order) 8 | } 9 | \arguments{ 10 | \item{mat}{Input matrix.} 11 | 12 | \item{new.order}{Vector of integer numbers with the new order of rows. The 13 | new order must contain as many elements as the matrix has rows and it must 14 | not contain NA values, duplicate entries, or gaps.} 15 | } 16 | \value{ 17 | Reordered matrix. 18 | } 19 | \description{ 20 | Reorder a matrix vertically according to a vector of new positions. 21 | } 22 | \details{ 23 | This function takes a matrix and reorders its rows based on a vector of new 24 | positions. 25 | } 26 | \seealso{ 27 | \code{\link{matrixreg}} 28 | } 29 | \author{ 30 | Philip Leifeld 31 | } 32 | \keyword{internal} 33 | -------------------------------------------------------------------------------- /man/extract-simex-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,simex-method} 4 | \alias{extract,simex-method} 5 | \alias{extract.simex} 6 | \title{\code{\link{extract}} method for \code{simex} objects} 7 | \usage{ 8 | \S4method{extract}{simex}(model, jackknife = TRUE, include.nobs = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{jackknife}{Use Jackknife variance instead of asymptotic variance?} 14 | 15 | \item{include.nobs}{Report the number of observations in the GOF block?} 16 | 17 | \item{...}{Custom parameters, which are handed over to subroutines, in this 18 | case to the \code{summary} method for the object.} 19 | } 20 | \description{ 21 | \code{\link{extract}} method for \code{simex} objects created by the 22 | \code{\link[simex]{simex}} function in the \pkg{simex} package. 23 | } 24 | -------------------------------------------------------------------------------- /man/extract-btergm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,btergm-method} 4 | \alias{extract,btergm-method} 5 | \alias{extract.btergm} 6 | \title{\code{\link{extract}} method for \code{btergm} objects} 7 | \usage{ 8 | \S4method{extract}{btergm}(model, level = 0.95, include.nobs = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{level}{Significance or confidence level (\code{1 - alpha}) for 14 | computing confidence intervals.} 15 | 16 | \item{include.nobs}{Report the number of observations in the GOF block?} 17 | 18 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 19 | not in use.} 20 | } 21 | \description{ 22 | \code{\link{extract}} method for \code{btergm} objects created by the 23 | \code{\link[btergm]{btergm}} function in the \pkg{btergm} package. 24 | } 25 | -------------------------------------------------------------------------------- /man/extract-mhurdle-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,mhurdle-method} 4 | \alias{extract,mhurdle-method} 5 | \alias{extract.mhurdle} 6 | \title{\code{\link{extract}} method for \code{mhurdle} objects} 7 | \usage{ 8 | \S4method{extract}{mhurdle}(model, include.nobs = TRUE, include.loglik = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.nobs}{Report the number of observations in the GOF block?} 14 | 15 | \item{include.loglik}{Report the log likelihood in the GOF block?} 16 | 17 | \item{...}{Custom parameters, which are handed over to subroutines, in this 18 | case to the \code{summary} method for the object.} 19 | } 20 | \description{ 21 | \code{\link{extract}} method for \code{mhurdle} objects created by the 22 | \code{\link[mhurdle]{mhurdle}} function in the \pkg{mhurdle} package. 23 | } 24 | -------------------------------------------------------------------------------- /man/show-texreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{show,texreg-method} 4 | \alias{show,texreg-method} 5 | \title{Show method for pretty output of \linkS4class{texreg} objects} 6 | \usage{ 7 | \S4method{show}{texreg}(object) 8 | } 9 | \arguments{ 10 | \item{object}{The \linkS4class{texreg} object to display.} 11 | } 12 | \description{ 13 | Show method for pretty output of \linkS4class{texreg} objects. 14 | } 15 | \details{ 16 | Print the different slots of \linkS4class{texreg} objects to the screen. 17 | } 18 | \references{ 19 | Leifeld, Philip (2013). texreg: Conversion of Statistical Model 20 | Output in R to LaTeX and HTML Tables. Journal of Statistical Software 21 | 55(8): 1-24. \doi{10.18637/jss.v055.i08}. 22 | } 23 | \seealso{ 24 | \code{\link{extract}}, \code{\link{createTexreg}}, 25 | \code{\link{screenreg}} 26 | } 27 | \author{ 28 | Philip Leifeld 29 | } 30 | -------------------------------------------------------------------------------- /man/extract-bergm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,bergm-method} 4 | \alias{extract,bergm-method} 5 | \alias{extract.bergm} 6 | \title{\code{\link{extract}} method for \code{bergm} objects} 7 | \usage{ 8 | \S4method{extract}{bergm}(model, posterior.median = FALSE, level = 0.95, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{posterior.median}{Report the posterior median instead of the default 14 | posterior mean as coefficients?} 15 | 16 | \item{level}{Confidence level, i.e., the proportion of the posterior 17 | distribution to be included in the credible interval.} 18 | 19 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 20 | not in use.} 21 | } 22 | \description{ 23 | \code{\link{extract}} method for \code{bergm} objects created by the 24 | \code{\link[Bergm]{bergm}} function in the \pkg{Bergm} package. 25 | } 26 | -------------------------------------------------------------------------------- /man/names2latex.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{names2latex} 4 | \alias{names2latex} 5 | \title{Replace symbols in a character string or vector by LaTeX equivalents} 6 | \usage{ 7 | names2latex(x) 8 | } 9 | \arguments{ 10 | \item{x}{A \code{character} object of arbitrary length.} 11 | } 12 | \value{ 13 | Same as the input object but with escaped or replaced symbols. 14 | } 15 | \description{ 16 | Replace symbols in a character string or vector by LaTeX equivalents- 17 | } 18 | \details{ 19 | This function is an internal helper function that takes a \code{character} 20 | object or vector and replaces symbols like underscores, angle brackets, or 21 | superscripted numbers by properly escaped LaTeX equivalents in order not to 22 | break any LaTeX table code when the \code{link{texreg}} function is used. 23 | } 24 | \seealso{ 25 | \code{\link{texreg}} 26 | } 27 | \author{ 28 | Philip Leifeld 29 | } 30 | \keyword{internal} 31 | -------------------------------------------------------------------------------- /man/extract-averaging-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,averaging-method} 4 | \alias{extract,averaging-method} 5 | \alias{extract.averaging} 6 | \title{\code{\link{extract}} method for \code{averaging} objects} 7 | \usage{ 8 | \S4method{extract}{averaging}(model, use.ci = FALSE, adjusted.se = FALSE, include.nobs = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{use.ci}{Report confidence intervals in the GOF block?} 14 | 15 | \item{adjusted.se}{Report adjusted standard error in the GOF block?} 16 | 17 | \item{include.nobs}{Report the number of observations in the GOF block?} 18 | 19 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 20 | not in use.} 21 | } 22 | \description{ 23 | \code{\link{extract}} method for \code{averaging} objects created by the 24 | \code{\link[MuMIn]{model.avg}} function in the \pkg{MuMIn} package. 25 | } 26 | -------------------------------------------------------------------------------- /man/extract-pgmm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,pgmm-method} 4 | \alias{extract,pgmm-method} 5 | \alias{extract.pgmm} 6 | \title{\code{\link{extract}} method for \code{pgmm} objects} 7 | \usage{ 8 | \S4method{extract}{pgmm}( 9 | model, 10 | include.nobs = TRUE, 11 | include.sargan = TRUE, 12 | include.wald = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.nobs}{Report the number of observations in the GOF block?} 20 | 21 | \item{include.sargan}{Report the Sargan test?} 22 | 23 | \item{include.wald}{Report the Wald statistic?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines, in this 26 | case to the \code{summary} method for the object.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{pgmm} objects created by the 30 | \code{\link[plm]{pgmm}} function in the \pkg{plm} package. 31 | } 32 | -------------------------------------------------------------------------------- /man/extract-gee-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gee-method} 4 | \alias{extract,gee-method} 5 | \alias{extract.gee} 6 | \title{\code{\link{extract}} method for \code{gee} objects} 7 | \usage{ 8 | \S4method{extract}{gee}(model, robust = TRUE, include.scale = TRUE, include.nobs = TRUE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{robust}{If TRUE computes robust standard errors in the 14 | variance-covariance matrix.} 15 | 16 | \item{include.scale}{Report the dispersion or scale parameter?} 17 | 18 | \item{include.nobs}{Report the number of observations in the GOF block?} 19 | 20 | \item{...}{Custom parameters, which are handed over to subroutines, in this 21 | case to the \code{summary} method for the object.} 22 | } 23 | \description{ 24 | \code{\link{extract}} method for \code{gee} objects created by the 25 | \code{\link[gee]{gee}} function in the \pkg{gee} package. 26 | } 27 | -------------------------------------------------------------------------------- /man/extract-lrm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lrm-method} 4 | \alias{extract,lrm-method} 5 | \alias{extract.lrm} 6 | \title{\code{\link{extract}} method for \code{lrm} objects} 7 | \usage{ 8 | \S4method{extract}{lrm}( 9 | model, 10 | include.pseudors = TRUE, 11 | include.lr = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.pseudors}{Report pseudo R^2 in the GOF block?} 20 | 21 | \item{include.lr}{Report likelihood ratio test?} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 26 | not in use.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{lrm} objects created by the 30 | \code{\link[rms]{lrm}} function in the \pkg{rms} package. 31 | } 32 | \author{ 33 | Fabrice Le Lec 34 | } 35 | -------------------------------------------------------------------------------- /man/extract-betaor-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,betaor-method} 4 | \alias{extract,betaor-method} 5 | \alias{extract.betaor} 6 | \title{\code{\link{extract}} method for \code{betaor} objects} 7 | \usage{ 8 | \S4method{extract}{betaor}( 9 | model, 10 | include.pseudors = TRUE, 11 | include.loglik = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.pseudors}{Report pseudo R^2 in the GOF block?} 20 | 21 | \item{include.loglik}{Report the log likelihood in the GOF block?} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 26 | not in use.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{betaor} objects created by the 30 | \code{\link[mfx]{betaor}} function in the \pkg{mfx} package. 31 | } 32 | -------------------------------------------------------------------------------- /man/extract-betamfx-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,betamfx-method} 4 | \alias{extract,betamfx-method} 5 | \alias{extract.betamfx} 6 | \title{\code{\link{extract}} method for \code{betamfx} objects} 7 | \usage{ 8 | \S4method{extract}{betamfx}( 9 | model, 10 | include.pseudors = TRUE, 11 | include.loglik = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.pseudors}{Report pseudo R^2 in the GOF block?} 20 | 21 | \item{include.loglik}{Report the log likelihood in the GOF block?} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 26 | not in use.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{betamfx} objects created by the 30 | \code{\link[mfx]{betamfx}} function in the \pkg{mfx} package. 31 | } 32 | -------------------------------------------------------------------------------- /man/extract-biglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,biglm-method} 4 | \alias{extract,biglm-method} 5 | \alias{extract.biglm} 6 | \title{\code{\link{extract}} method for \code{biglm} objects} 7 | \usage{ 8 | \S4method{extract}{biglm}(model, include.nobs = TRUE, include.aic = TRUE, use.ci = FALSE, ...) 9 | } 10 | \arguments{ 11 | \item{model}{A statistical model object.} 12 | 13 | \item{include.nobs}{Report the number of observations in the GOF block?} 14 | 15 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 16 | block?} 17 | 18 | \item{use.ci}{Report confidence intervals in the GOF block?} 19 | 20 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 21 | not in use.} 22 | } 23 | \description{ 24 | \code{\link{extract}} method for \code{biglm} objects created by the 25 | \code{\link[biglm]{biglm}} function in the \pkg{biglm} package. 26 | } 27 | \author{ 28 | Claudia Zucca, Philip Leifeld 29 | } 30 | -------------------------------------------------------------------------------- /man/extract-geeglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,geeglm-method} 4 | \alias{extract,geeglm-method} 5 | \alias{extract.geeglm} 6 | \title{\code{\link{extract}} method for \code{geeglm} objects} 7 | \usage{ 8 | \S4method{extract}{geeglm}( 9 | model, 10 | include.scale = TRUE, 11 | include.correlation = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.scale}{Report the dispersion or scale parameter?} 20 | 21 | \item{include.correlation}{Report the correlation parameter alpha and its 22 | standard error?} 23 | 24 | \item{include.nobs}{Report the number of observations in the GOF block?} 25 | 26 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 27 | not in use.} 28 | } 29 | \description{ 30 | \code{\link{extract}} method for \code{geeglm} objects created by the 31 | \code{geeglm} function in the \pkg{geepack} package. 32 | } 33 | -------------------------------------------------------------------------------- /man/extract-prais-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,prais-method} 4 | \alias{extract,prais-method} 5 | \alias{extract.prais} 6 | \title{\code{\link{extract}} method for \code{prais} objects} 7 | \usage{ 8 | \S4method{extract}{prais}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.rsquared}{Report R^2 in the GOF block?} 20 | 21 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines, in this 26 | case to the \code{summary} method for the object.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{prais} objects created by the 30 | \code{\link[prais]{prais_winsten}} function in the \pkg{prais} package. 31 | } 32 | -------------------------------------------------------------------------------- /man/extract-fGARCH-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,fGARCH-method} 4 | \alias{extract,fGARCH-method} 5 | \alias{extract.fGARCH} 6 | \title{\code{\link{extract}} method for \code{fGARCH} objects} 7 | \usage{ 8 | \S4method{extract}{fGARCH}( 9 | model, 10 | include.nobs = TRUE, 11 | include.aic = TRUE, 12 | include.loglik = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.nobs}{Report the number of observations in the GOF block?} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.loglik}{Report the log likelihood in the GOF block?} 25 | 26 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 27 | not in use.} 28 | } 29 | \description{ 30 | \code{\link{extract}} method for \code{fGARCH} objects created by the 31 | \code{\link[fGarch]{garchFit}} function in the \pkg{fGarch} package. 32 | } 33 | -------------------------------------------------------------------------------- /man/extract-vglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,vglm-method} 4 | \alias{extract,vglm-method} 5 | \alias{extract.vglm} 6 | \title{\code{\link{extract}} method for \code{vglm} objects} 7 | \usage{ 8 | \S4method{extract}{vglm}( 9 | model, 10 | include.loglik = TRUE, 11 | include.df = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.loglik}{Report the log likelihood in the GOF block?} 20 | 21 | \item{include.df}{Report the degrees of freedom?} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 26 | not in use.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{vglm} objects created by the 30 | \code{\link[VGAM]{vglm}} function in the \pkg{VGAM} package. 31 | } 32 | \author{ 33 | Christoph Riedl 34 | } 35 | -------------------------------------------------------------------------------- /man/texreg-package.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{texreg-package} 4 | \alias{texreg-package} 5 | \title{Conversion of \R Regression Output to LaTeX or HTML Tables} 6 | \description{ 7 | \pkg{texreg} converts coefficients, standard errors, uncertainty measures, 8 | and goodness-of-fit statistics of statistical models into LaTeX or HTML 9 | tables or into nicely formatted screen output for the \R console. A list of 10 | several models can be combined in a single table. The output is 11 | customizable. New model types can be easily implemented. Confidence 12 | intervals can be used instead of standard errors and p-values. 13 | } 14 | \references{ 15 | Leifeld, Philip (2013). texreg: Conversion of Statistical Model 16 | Output in R to LaTeX and HTML Tables. Journal of Statistical Software 17 | 55(8): 1-24. \doi{10.18637/jss.v055.i08}. 18 | } 19 | \seealso{ 20 | \code{\link{extract}} \code{\link{texreg}} 21 | } 22 | \author{ 23 | Philip Leifeld 24 | } 25 | \keyword{package} 26 | -------------------------------------------------------------------------------- /man/extract-pglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,pglm-method} 4 | \alias{extract,pglm-method} 5 | \alias{extract.pglm} 6 | \title{\code{\link{extract}} method for \code{pglm} objects} 7 | \usage{ 8 | \S4method{extract}{pglm}( 9 | model, 10 | include.aic = TRUE, 11 | include.loglik = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 20 | block?} 21 | 22 | \item{include.loglik}{Report the log likelihood in the GOF block?} 23 | 24 | \item{include.nobs}{Report the number of observations in the GOF block?} 25 | 26 | \item{...}{Custom parameters, which are handed over to subroutines, in this 27 | case to the \code{summary} method for the object.} 28 | } 29 | \description{ 30 | \code{\link{extract}} method for \code{pglm} objects created by the 31 | \code{\link[pglm]{pglm}} function in the \pkg{pglm} package. 32 | } 33 | -------------------------------------------------------------------------------- /man/extract-bife-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,bife-method} 4 | \alias{extract,bife-method} 5 | \alias{extract.bife} 6 | \title{\code{\link{extract}} method for \code{bife} objects} 7 | \usage{ 8 | \S4method{extract}{bife}( 9 | model, 10 | include.loglik = TRUE, 11 | include.deviance = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.loglik}{Report the log likelihood in the GOF block?} 20 | 21 | \item{include.deviance}{Report the residual deviance?} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 26 | not in use.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{bife} objects created by the 30 | \code{\link[bife]{bife}} function in the \pkg{bife} package. 31 | } 32 | \author{ 33 | Philip Leifeld, Christoph Riedl, Claudia Zucca 34 | } 35 | -------------------------------------------------------------------------------- /man/extract-ergm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,ergm-method} 4 | \alias{extract,ergm-method} 5 | \alias{extract.ergm} 6 | \title{\code{\link{extract}} method for \code{ergm} objects} 7 | \usage{ 8 | \S4method{extract}{ergm}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 20 | block?} 21 | 22 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 23 | block?} 24 | 25 | \item{include.loglik}{Report the log likelihood in the GOF block?} 26 | 27 | \item{...}{Custom parameters, which are handed over to subroutines, in this 28 | case to the \code{summary} method for the object.} 29 | } 30 | \description{ 31 | \code{\link{extract}} method for \code{ergm} objects created by the 32 | \code{\link[ergm]{ergm}} function in the \pkg{ergm} package. 33 | } 34 | -------------------------------------------------------------------------------- /man/extract-pcce-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,pcce-method} 4 | \alias{extract,pcce-method} 5 | \alias{extract.pcce} 6 | \title{\code{\link{extract}} method for \code{pcce} objects} 7 | \usage{ 8 | \S4method{extract}{pcce}( 9 | model, 10 | include.r.squared = TRUE, 11 | include.sumsquares = TRUE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.r.squared}{Report the HPY R-squared statistic in the GOF block?} 20 | 21 | \item{include.sumsquares}{Report the total and residual sum of squares in the 22 | GOF block?} 23 | 24 | \item{include.nobs}{Report the number of observations in the GOF block?} 25 | 26 | \item{...}{Custom parameters, which are handed over to subroutines, in this 27 | case to the \code{summary} method for the object.} 28 | } 29 | \description{ 30 | \code{\link{extract}} method for \code{pcce} objects created by the 31 | \code{\link[plm]{pcce}} function in the \pkg{plm} package. 32 | } 33 | -------------------------------------------------------------------------------- /man/extract-feglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,feglm-method} 4 | \alias{extract,feglm-method} 5 | \alias{extract.feglm} 6 | \title{\code{\link{extract}} method for \code{feglm} objects} 7 | \usage{ 8 | \S4method{extract}{feglm}( 9 | model, 10 | include.deviance = TRUE, 11 | include.nobs = TRUE, 12 | include.groups = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.deviance}{Report the deviance?} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.groups}{Report the number of groups?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines, in this 26 | case to the \code{summary} method for the object.} 27 | } 28 | \description{ 29 | \code{\link{extract}} method for \code{feglm} objects created by the 30 | \code{\link[alpaca]{feglm}} function in the \pkg{alpaca} package. 31 | } 32 | \author{ 33 | Christoph Riedl, Oliver Reiter, Philip Leifeld 34 | } 35 | -------------------------------------------------------------------------------- /man/extract-plm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,plm-method} 4 | \alias{extract,plm-method} 5 | \alias{extract.plm} 6 | \title{\code{\link{extract}} method for \code{plm} objects} 7 | \usage{ 8 | \S4method{extract}{plm}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.variance = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.rsquared}{Report R^2 in the GOF block?} 21 | 22 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 23 | 24 | \item{include.nobs}{Report the number of observations in the GOF block?} 25 | 26 | \item{include.variance}{Report group variances?} 27 | 28 | \item{...}{Custom parameters, which are handed over to subroutines, in this 29 | case to the \code{summary} method for the object.} 30 | } 31 | \description{ 32 | \code{\link{extract}} method for \code{plm} objects created by the 33 | \code{\link[plm]{plm}} function in the \pkg{plm} package. 34 | } 35 | -------------------------------------------------------------------------------- /man/extract-wls-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,wls-method} 4 | \alias{extract,wls-method} 5 | \alias{extract.wls} 6 | \title{\code{\link{extract}} method for \code{wls} objects} 7 | \usage{ 8 | \S4method{extract}{wls}( 9 | model, 10 | include.statistics = TRUE, 11 | include.nobs = TRUE, 12 | include.aic = TRUE, 13 | include.bic = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.statistics}{Report RMSEA and other GOF statistics?} 21 | 22 | \item{include.nobs}{Report the number of observations in the GOF block?} 23 | 24 | \item{include.aic}{Report AIC?} 25 | 26 | \item{include.bic}{Report BIC?} 27 | 28 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 29 | not in use.} 30 | } 31 | \description{ 32 | \code{\link{extract}} method for \code{wls} objects created by the 33 | \code{\link[metaSEM]{wls}} function in the \pkg{metaSEM} package. 34 | } 35 | \author{ 36 | Christoph Riedl 37 | 38 | Philip Leifeld 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-gmm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gmm-method} 4 | \alias{extract,gmm-method} 5 | \alias{extract.gmm} 6 | \title{\code{\link{extract}} method for \code{gmm} objects} 7 | \usage{ 8 | \S4method{extract}{gmm}( 9 | model, 10 | include.obj.fcn = TRUE, 11 | include.overidentification = FALSE, 12 | include.nobs = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{include.obj.fcn}{Report the value of the objective function 20 | (= criterion function)? More precisely, this returns 21 | \code{E(g)var(g)^{-1}E(g)}.} 22 | 23 | \item{include.overidentification}{Report the J-test for overidentification?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{...}{Custom parameters, which are handed over to subroutines, in this 28 | case to the \code{summary} method for the object.} 29 | } 30 | \description{ 31 | \code{\link{extract}} method for \code{gmm} objects created by the 32 | \code{\link[gmm]{gmm}} function in the \pkg{gmm} package. 33 | } 34 | -------------------------------------------------------------------------------- /man/extract-netlogit-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,netlogit-method} 4 | \alias{extract,netlogit-method} 5 | \alias{extract.netlogit} 6 | \title{\code{\link{extract}} method for \code{netlogit} objects} 7 | \usage{ 8 | \S4method{extract}{netlogit}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.deviance = TRUE, 13 | include.nobs = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 21 | block?} 22 | 23 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 24 | block?} 25 | 26 | \item{include.deviance}{Report the deviance?} 27 | 28 | \item{include.nobs}{Report the number of observations in the GOF block?} 29 | 30 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 31 | not in use.} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{netlogit} objects created by the 35 | \code{netlogit} function in the \pkg{sna} package. 36 | } 37 | -------------------------------------------------------------------------------- /man/extract-gamlssZadj-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gamlssZadj-method} 4 | \alias{extract,gamlssZadj-method} 5 | \alias{extract.gamlssZadj} 6 | \title{\code{\link{extract}} method for \code{gamlssZadj} objects} 7 | \usage{ 8 | \S4method{extract}{gamlssZadj}( 9 | model, 10 | type = c("qr", "vcov"), 11 | include.nobs = TRUE, 12 | include.gaic = TRUE, 13 | ... 14 | ) 15 | } 16 | \arguments{ 17 | \item{model}{A statistical model object.} 18 | 19 | \item{type}{The type.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.gaic}{Report Generalized Akaike's Information Criterion (AIC) 24 | in the GOF block?} 25 | 26 | \item{...}{Custom parameters, which are handed over to subroutines, in this 27 | case to the \code{vcov} method for the object.} 28 | } 29 | \description{ 30 | \code{\link{extract}} method for \code{gamlssZadj} objects created by the 31 | \code{\link[gamlss.inf]{gamlssZadj}} function in the \pkg{gamlss.inf} 32 | package. 33 | } 34 | \author{ 35 | Ricardo Graiff Garcia, Philip Leifeld 36 | } 37 | -------------------------------------------------------------------------------- /man/get.data.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{get.data} 4 | \alias{get.data} 5 | \title{Extract all data necessary for generating a table from statistical models} 6 | \usage{ 7 | get.data(l, ...) 8 | } 9 | \arguments{ 10 | \item{l}{A list of statistical models.} 11 | 12 | \item{...}{Arguments to be passed over to the \code{\link{extract}} function, 13 | such as \code{include.nobs} or \code{include.aic}. Details are provided in 14 | the documentation of the \code{\link{extract}} function.} 15 | } 16 | \value{ 17 | A list of \linkS4class{texreg} objects. 18 | } 19 | \description{ 20 | Extract all data necessary for generating a table from a list of models. 21 | } 22 | \details{ 23 | This function applies the \code{link{extract}} function and its respective 24 | methods to each element in a list of statistical models in order to extract 25 | coefficients, standard errors, p-values, confidence intervals, and 26 | goodness-of-fit statistics for generating a regression table. 27 | } 28 | \seealso{ 29 | \code{\link{extract}} 30 | } 31 | \author{ 32 | Philip Leifeld 33 | } 34 | \keyword{internal} 35 | -------------------------------------------------------------------------------- /man/extract-betareg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,betareg-method} 4 | \alias{extract,betareg-method} 5 | \alias{extract.betareg} 6 | \title{\code{\link{extract}} method for \code{betareg} objects} 7 | \usage{ 8 | \S4method{extract}{betareg}( 9 | model, 10 | include.precision = TRUE, 11 | include.pseudors = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.precision}{Report precision in the GOF block?} 21 | 22 | \item{include.pseudors}{Report pseudo R^2 in the GOF block?} 23 | 24 | \item{include.loglik}{Report the log likelihood in the GOF block?} 25 | 26 | \item{include.nobs}{Report the number of observations in the GOF block?} 27 | 28 | \item{...}{Custom parameters, which are handed over to subroutines, in this 29 | case to the \code{summary} method for the object.} 30 | } 31 | \description{ 32 | \code{\link{extract}} method for \code{betareg} objects created by the 33 | \code{\link[betareg]{betareg}} function in the \pkg{betareg} package. 34 | } 35 | -------------------------------------------------------------------------------- /man/extract-logitr-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,logitr-method} 4 | \alias{extract,logitr-method} 5 | \alias{logitr} 6 | \title{\code{\link{extract}} method for \code{logitr} objects} 7 | \usage{ 8 | \S4method{extract}{logitr}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.aic = TRUE, 13 | include.bic = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.nobs}{Include the number of observations in summary table?} 21 | 22 | \item{include.loglik}{Include the log-likelihood in summary table?} 23 | 24 | \item{include.aic}{Include the the AIC in summary table?} 25 | 26 | \item{include.bic}{Include the the BIC in summary table?} 27 | 28 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 29 | not in use.} 30 | } 31 | \description{ 32 | \code{\link{extract}} method for \code{logitr} objects created by the 33 | \code{logitr} function in the \pkg{logitr} package. 34 | } 35 | \author{ 36 | John Paul Helveston, \email{john.helveston@gmail.com} 37 | } 38 | -------------------------------------------------------------------------------- /man/extract-ols-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,ols-method} 4 | \alias{extract,ols-method} 5 | \alias{extract.ols} 6 | \title{\code{\link{extract}} method for \code{ols} objects} 7 | \usage{ 8 | \S4method{extract}{ols}( 9 | model, 10 | include.nobs = TRUE, 11 | include.rsquared = TRUE, 12 | include.adjrs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.lr = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.rsquared}{Report R^2 in the GOF block?} 24 | 25 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 26 | 27 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 28 | 29 | \item{include.lr}{Report likelihood ratio test?} 30 | 31 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 32 | not in use.} 33 | } 34 | \description{ 35 | \code{\link{extract}} method for \code{ols} objects created by the 36 | \code{\link[rms]{ols}} function in the \pkg{rms} package. 37 | } 38 | -------------------------------------------------------------------------------- /man/extract-gls-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gls-method} 4 | \alias{extract,gls-method} 5 | \alias{extract.gls} 6 | \title{\code{\link{extract}} method for \code{gls} objects} 7 | \usage{ 8 | \S4method{extract}{gls}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 21 | block?} 22 | 23 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 24 | block?} 25 | 26 | \item{include.loglik}{Report the log likelihood in the GOF block?} 27 | 28 | \item{include.nobs}{Report the number of observations in the GOF block?} 29 | 30 | \item{...}{Custom parameters, which are handed over to subroutines, in this 31 | case to the \code{summary} method for the object.} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{gls} objects created by the 35 | \code{\link[nlme]{gls}} function in the \pkg{nlme} package. 36 | } 37 | -------------------------------------------------------------------------------- /man/extract-mtergm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,mtergm-method} 4 | \alias{extract,mtergm-method} 5 | \alias{extract.mtergm} 6 | \title{\code{\link{extract}} method for \code{mtergm} objects} 7 | \usage{ 8 | \S4method{extract}{mtergm}( 9 | model, 10 | include.nobs = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.nobs}{Report the number of observations in the GOF block?} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 26 | block?} 27 | 28 | \item{include.loglik}{Report the log likelihood in the GOF block?} 29 | 30 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 31 | not in use.} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{mtergm} objects created by the 35 | \code{\link[btergm:btergm]{mtergm}} function in the \pkg{btergm} package. 36 | } 37 | -------------------------------------------------------------------------------- /man/extract-gnls-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gnls-method} 4 | \alias{extract,gnls-method} 5 | \alias{extract.gnls} 6 | \title{\code{\link{extract}} method for \code{gnls} objects} 7 | \usage{ 8 | \S4method{extract}{gnls}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 21 | block?} 22 | 23 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 24 | block?} 25 | 26 | \item{include.loglik}{Report the log likelihood in the GOF block?} 27 | 28 | \item{include.nobs}{Report the number of observations in the GOF block?} 29 | 30 | \item{...}{Custom parameters, which are handed over to subroutines, in this 31 | case to the \code{summary} method for the object.} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{gnls} objects created by the 35 | \code{\link[nlme]{gnls}} function in the \pkg{nlme} package. 36 | } 37 | -------------------------------------------------------------------------------- /man/extract-truncreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,truncreg-method} 4 | \alias{extract,truncreg-method} 5 | \alias{extract.truncreg} 6 | \title{\code{\link{extract}} method for \code{truncreg} objects} 7 | \usage{ 8 | \S4method{extract}{truncreg}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.aic = TRUE, 13 | include.bic = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.nobs}{Report the number of observations in the GOF block?} 21 | 22 | \item{include.loglik}{Report the log likelihood in the GOF block?} 23 | 24 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 25 | block?} 26 | 27 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 28 | block?} 29 | 30 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 31 | not in use.} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{truncreg} objects created by the 35 | \code{\link[truncreg]{truncreg}} function in the \pkg{truncreg} package. 36 | } 37 | -------------------------------------------------------------------------------- /man/extract-censReg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,censReg-method} 4 | \alias{extract,censReg-method} 5 | \alias{extract.censReg} 6 | \title{\code{\link{extract}} method for \code{censReg} objects} 7 | \usage{ 8 | \S4method{extract}{censReg}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 21 | block?} 22 | 23 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 24 | block?} 25 | 26 | \item{include.loglik}{Report the log likelihood in the GOF block?} 27 | 28 | \item{include.nobs}{Report the number of observations in the GOF block?} 29 | 30 | \item{...}{Custom parameters, which are handed over to subroutines, in this 31 | case to the \code{summary} method for the object.} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{censReg} objects created by the 35 | \code{censReg} function in the \pkg{censReg} package. 36 | } 37 | -------------------------------------------------------------------------------- /man/extract-ets-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,ets-method} 4 | \alias{extract,ets-method} 5 | \alias{extract.ets} 6 | \title{\code{\link{extract}} method for \code{ets} objects} 7 | \usage{ 8 | \S4method{extract}{ets}( 9 | model, 10 | include.pvalues = FALSE, 11 | include.aic = TRUE, 12 | include.aicc = TRUE, 13 | include.bic = TRUE, 14 | include.loglik = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.pvalues}{Report p-values?} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.aicc}{Report AICC in the GOF block?} 27 | 28 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 29 | block?} 30 | 31 | \item{include.loglik}{Report the log likelihood in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{ets} objects created by the 38 | \code{\link[forecast]{ets}} function in the \pkg{forecast} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-gamlss-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gamlss-method} 4 | \alias{extract,gamlss-method} 5 | \alias{extract.gamlss} 6 | \title{\code{\link{extract}} method for \code{gamlss} objects} 7 | \usage{ 8 | \S4method{extract}{gamlss}( 9 | model, 10 | robust = FALSE, 11 | include.nobs = TRUE, 12 | include.nagelkerke = TRUE, 13 | include.gaic = TRUE, 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{robust}{If TRUE computes robust standard errors in the 21 | variance-covariance matrix.} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{include.nagelkerke}{Report Nagelkerke R^2 in the GOF block?} 26 | 27 | \item{include.gaic}{Report Generalized Akaike's Information Criterion (AIC) 28 | in the GOF block?} 29 | 30 | \item{...}{Custom parameters, which are handed over to subroutines, in this 31 | case to the \code{vcov} method for the object.} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{gamlss} objects created by the 35 | \code{\link[gamlss]{gamlss}} function in the \pkg{gamlss} package. 36 | } 37 | -------------------------------------------------------------------------------- /man/extract-Arima-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,Arima-method} 4 | \alias{extract,Arima-method} 5 | \alias{extract.Arima} 6 | \title{\code{\link{extract}} method for \code{Arima} objects} 7 | \usage{ 8 | \S4method{extract}{Arima}( 9 | model, 10 | include.pvalues = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.pvalues}{Report p-values?} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 27 | block?} 28 | 29 | \item{include.loglik}{Report the log likelihood in the GOF block?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{Arima} objects created by the 38 | \code{\link[stats]{arima}} function in the \pkg{stats} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-oglmx-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,oglmx-method} 4 | \alias{extract,oglmx-method} 5 | \alias{extract.oglmx} 6 | \title{\code{\link{extract}} method for \code{oglmx} objects} 7 | \usage{ 8 | \S4method{extract}{oglmx}( 9 | model, 10 | include.aic = TRUE, 11 | include.iterations = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | include.rsquared = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.iterations}{Report the number of iterations?} 25 | 26 | \item{include.loglik}{Report the log likelihood in the GOF block?} 27 | 28 | \item{include.nobs}{Report the number of observations in the GOF block?} 29 | 30 | \item{include.rsquared}{Report R^2 in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines, in this 33 | case to the \code{summary} method for the object.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{oglmx} objects created by the oglmx 37 | function in the oglmx package. 38 | } 39 | -------------------------------------------------------------------------------- /man/extract-lnam-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lnam-method} 4 | \alias{extract,lnam-method} 5 | \alias{extract.lnam} 6 | \title{\code{\link{extract}} method for \code{lnam} objects} 7 | \usage{ 8 | \S4method{extract}{lnam}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.aic = TRUE, 13 | include.bic = TRUE, 14 | include.loglik = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 26 | block?} 27 | 28 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 29 | block?} 30 | 31 | \item{include.loglik}{Report the log likelihood in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{coef} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{lnam} objects created by the 38 | \code{lnam} function in the \pkg{sna} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-logitor-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,logitor-method} 4 | \alias{extract,logitor-method} 5 | \alias{extract.logitor} 6 | \title{\code{\link{extract}} method for \code{logitor} objects} 7 | \usage{ 8 | \S4method{extract}{logitor}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.deviance = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.deviance}{Report the deviance?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{logitor} objects created by the 38 | \code{\link[mfx]{logitor}} function in the \pkg{mfx} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-Sarlm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,Sarlm-method} 4 | \alias{extract,Sarlm-method} 5 | \alias{extract.Sarlm} 6 | \title{\code{\link{extract}} method for \code{Sarlm} objects} 7 | \usage{ 8 | \S4method{extract}{Sarlm}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.aic = TRUE, 13 | include.lr = TRUE, 14 | include.wald = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 26 | block?} 27 | 28 | \item{include.lr}{Report likelihood ratio test?} 29 | 30 | \item{include.wald}{Report the Wald statistic?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines, in this 33 | case to the \code{summary} method for the object.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{Sarlm} objects created by the 37 | \code{\link[spatialreg:ML_models]{lagsarlm}} function in the \pkg{spatialreg} 38 | package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-glm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,glm-method} 4 | \alias{extract,glm-method} 5 | \alias{extract.glm} 6 | \title{\code{\link{extract}} method for \code{glm} objects} 7 | \usage{ 8 | \S4method{extract}{glm}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 25 | block?} 26 | 27 | \item{include.loglik}{Report the log likelihood in the GOF block?} 28 | 29 | \item{include.deviance}{Report the deviance?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{glm} objects created by the 38 | \code{\link[stats]{glm}} function in the \pkg{stats} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-logitmfx-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,logitmfx-method} 4 | \alias{extract,logitmfx-method} 5 | \alias{extract.logitmfx} 6 | \title{\code{\link{extract}} method for \code{logitmfx} objects} 7 | \usage{ 8 | \S4method{extract}{logitmfx}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.deviance = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.deviance}{Report the deviance?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{logitmfx} objects created by the 38 | \code{\link[mfx]{logitmfx}} function in the \pkg{mfx} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-lm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lm-method} 4 | \alias{extract,lm-method} 5 | \alias{extract.lm} 6 | \title{\code{\link{extract}} method for \code{lm} objects} 7 | \usage{ 8 | \S4method{extract}{lm}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.rmse = FALSE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 28 | 29 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 30 | standard deviation) in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines, in this 33 | case to the \code{summary} method for the object.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{lm} objects created by the 37 | \code{\link[stats]{lm}} function in the \pkg{stats} package. 38 | } 39 | -------------------------------------------------------------------------------- /man/extract-negbinirr-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,negbinirr-method} 4 | \alias{extract,negbinirr-method} 5 | \alias{extract.negbinirr} 6 | \title{\code{\link{extract}} method for \code{negbinirr} objects} 7 | \usage{ 8 | \S4method{extract}{negbinirr}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.deviance = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.deviance}{Report the deviance?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{negbinirr} objects created by the 38 | \code{\link[mfx]{negbinirr}} function in the \pkg{mfx} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-negbinmfx-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,negbinmfx-method} 4 | \alias{extract,negbinmfx-method} 5 | \alias{extract.negbinmfx} 6 | \title{\code{\link{extract}} method for \code{negbinmfx} objects} 7 | \usage{ 8 | \S4method{extract}{negbinmfx}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.deviance = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.deviance}{Report the deviance?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{negbinmfx} objects created by the 38 | \code{\link[mfx]{negbinmfx}} function in the \pkg{mfx} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-probitmfx-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,probitmfx-method} 4 | \alias{extract,probitmfx-method} 5 | \alias{extract.probitmfx} 6 | \title{\code{\link{extract}} method for \code{probitmfx} objects} 7 | \usage{ 8 | \S4method{extract}{probitmfx}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.deviance = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.deviance}{Report the deviance?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{probitmfx} objects created by the 38 | \code{\link[mfx]{probitmfx}} function in the \pkg{mfx} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-brglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,brglm-method} 4 | \alias{extract,brglm-method} 5 | \alias{extract.brglm} 6 | \title{\code{\link{extract}} method for \code{brglm} objects} 7 | \usage{ 8 | \S4method{extract}{brglm}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 25 | block?} 26 | 27 | \item{include.loglik}{Report the log likelihood in the GOF block?} 28 | 29 | \item{include.deviance}{Report the deviance?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{brglm} objects created by the 38 | \code{\link[brglm]{brglm}} function in the \pkg{brglm} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-model.selection-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,model.selection-method} 4 | \alias{extract,model.selection-method} 5 | \alias{extract.model.selection} 6 | \title{\code{\link{extract}} method for \code{model.selection} objects} 7 | \usage{ 8 | \S4method{extract}{model.selection}( 9 | model, 10 | include.loglik = TRUE, 11 | include.aicc = TRUE, 12 | include.delta = TRUE, 13 | include.weight = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.loglik}{Report the log likelihood in the GOF block?} 22 | 23 | \item{include.aicc}{Report AICC in the GOF block?} 24 | 25 | \item{include.delta}{Report the delta statistic?} 26 | 27 | \item{include.weight}{Report Akaike weights?} 28 | 29 | \item{include.nobs}{Report the number of observations in the GOF block?} 30 | 31 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 32 | not in use.} 33 | } 34 | \description{ 35 | \code{\link{extract}} method for \code{model.selection} objects created by 36 | the \code{\link[MuMIn]{model.sel}} and \code{\link[MuMIn]{dredge}} functions 37 | in the \pkg{MuMIn} package. 38 | } 39 | -------------------------------------------------------------------------------- /man/extract-poissonirr-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,poissonirr-method} 4 | \alias{extract,poissonirr-method} 5 | \alias{extract.poissonirr} 6 | \title{\code{\link{extract}} method for \code{poissonirr} objects} 7 | \usage{ 8 | \S4method{extract}{poissonirr}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.deviance = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.deviance}{Report the deviance?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{poissonirr} objects created by the 38 | \code{\link[mfx]{poissonirr}} function in the \pkg{mfx} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-poissonmfx-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,poissonmfx-method} 4 | \alias{extract,poissonmfx-method} 5 | \alias{extract.poissonmfx} 6 | \title{\code{\link{extract}} method for \code{poissonmfx} objects} 7 | \usage{ 8 | \S4method{extract}{poissonmfx}( 9 | model, 10 | include.nobs = TRUE, 11 | include.loglik = TRUE, 12 | include.deviance = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nobs}{Report the number of observations in the GOF block?} 22 | 23 | \item{include.loglik}{Report the log likelihood in the GOF block?} 24 | 25 | \item{include.deviance}{Report the deviance?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{poissonmfx} objects created by the 38 | \code{\link[mfx]{poissonmfx}} function in the \pkg{mfx} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-rem.dyad-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,rem.dyad-method} 4 | \alias{extract,rem.dyad-method} 5 | \alias{extract.rem.dyad} 6 | \title{\code{\link{extract}} method for \code{rem.dyad} objects} 7 | \usage{ 8 | \S4method{extract}{rem.dyad}( 9 | model, 10 | include.nvertices = TRUE, 11 | include.events = TRUE, 12 | include.aic = TRUE, 13 | include.aicc = TRUE, 14 | include.bic = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.nvertices}{Report the number of vertices in a STERGM?} 22 | 23 | \item{include.events}{Report the number of events in the GOF block?} 24 | 25 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 26 | block?} 27 | 28 | \item{include.aicc}{Report AICC in the GOF block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{rem.dyad} objects created by the 38 | \code{\link[relevent]{rem.dyad}} function in the \pkg{relevent} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-negbin-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,negbin-method} 4 | \alias{extract,negbin-method} 5 | \alias{extract.negbin} 6 | \title{\code{\link{extract}} method for \code{negbin} objects} 7 | \usage{ 8 | \S4method{extract}{negbin}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 25 | block?} 26 | 27 | \item{include.loglik}{Report the log likelihood in the GOF block?} 28 | 29 | \item{include.deviance}{Report the deviance?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{negbin} objects created by the 38 | \code{\link[MASS]{glm.nb}} function in the \pkg{MASS} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/coeftostring.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{coeftostring} 4 | \alias{coeftostring} 5 | \title{Convert a number into a string with rounded decimal places} 6 | \usage{ 7 | coeftostring(x, lead.zero = FALSE, digits = 2) 8 | } 9 | \arguments{ 10 | \item{x}{A \code{numeric} object to reformat.} 11 | 12 | \item{lead.zero}{Should a leading zero be printed if the coefficient is 13 | non-negative and smaller than one (e.g., \code{"0.23"} as opposed to 14 | \code{".23"})?} 15 | 16 | \item{digits}{Number of decimal places to round to.} 17 | } 18 | \value{ 19 | A reformatted coefficient string as a \code{character} object. 20 | } 21 | \description{ 22 | Reformat a coefficient as a string with a certain number of decimal places. 23 | } 24 | \details{ 25 | This function takes a \code{numeric} object, usually a coefficient from a 26 | statistical model, and converts it into a \code{character} object. The user 27 | can choose to how many decimal places the number is rounded (usually two in 28 | most published regression models) and whether there should be a leading zero 29 | if the coefficient is between 0 and 1. 30 | } 31 | \seealso{ 32 | \code{\link{texreg}} 33 | } 34 | \author{ 35 | Philip Leifeld 36 | } 37 | \keyword{internal} 38 | -------------------------------------------------------------------------------- /man/extract-clm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,clm-method} 4 | \alias{extract,clm-method} 5 | \alias{extract.clm} 6 | \title{\code{\link{extract}} method for \code{clm} objects} 7 | \usage{ 8 | \S4method{extract}{clm}( 9 | model, 10 | include.thresholds = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.thresholds}{Report thresholds in the GOF block?} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 27 | block?} 28 | 29 | \item{include.loglik}{Report the log likelihood in the GOF block?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{clm} objects created by the 38 | \code{\link[ordinal]{clm}} function in the \pkg{ordinal} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-dynlm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,dynlm-method} 4 | \alias{extract,dynlm-method} 5 | \alias{extract.dynlm} 6 | \title{\code{\link{extract}} method for \code{dynlm} objects} 7 | \usage{ 8 | \S4method{extract}{dynlm}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.rmse = FALSE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 28 | 29 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 30 | standard deviation) in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines, in this 33 | case to the \code{summary} method for the object.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{dynlm} objects created by the 37 | \code{\link[dynlm]{dynlm}} function in the \pkg{dynlm} package. 38 | } 39 | -------------------------------------------------------------------------------- /man/extract-gel-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gel-method} 4 | \alias{extract,gel-method} 5 | \alias{extract.gel} 6 | \title{\code{\link{extract}} method for \code{gel} objects} 7 | \usage{ 8 | \S4method{extract}{gel}( 9 | model, 10 | include.obj.fcn = TRUE, 11 | include.overidentification = FALSE, 12 | include.nobs = TRUE, 13 | overIdentTest = c("LR", "LM", "J "), 14 | ... 15 | ) 16 | } 17 | \arguments{ 18 | \item{model}{A statistical model object.} 19 | 20 | \item{include.obj.fcn}{Report the value of the objective function 21 | (= criterion function)? More precisely, this returns 22 | \code{E(g)var(g)^{-1}E(g)}.} 23 | 24 | \item{include.overidentification}{Report the J-test for overidentification?} 25 | 26 | \item{include.nobs}{Report the number of observations in the GOF block?} 27 | 28 | \item{overIdentTest}{Which test statistics should be included in an 29 | overidentification test?} 30 | 31 | \item{...}{Custom parameters, which are handed over to subroutines, in this 32 | case to the \code{summary} method for the object.} 33 | } 34 | \description{ 35 | \code{\link{extract}} method for \code{gel} objects created by the 36 | \code{\link[gmm]{gel}} function in the \pkg{gmm} package. 37 | } 38 | -------------------------------------------------------------------------------- /man/extract-ivreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,ivreg-method} 4 | \alias{extract,ivreg-method} 5 | \alias{extract.ivreg} 6 | \title{\code{\link{extract}} method for \code{ivreg} objects} 7 | \usage{ 8 | \S4method{extract}{ivreg}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.rmse = FALSE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 28 | 29 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 30 | standard deviation) in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines, in this 33 | case to the \code{summary} method for the object.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{ivreg} objects created by the 37 | \code{\link[AER]{ivreg}} function in the \pkg{AER} package. 38 | } 39 | -------------------------------------------------------------------------------- /man/extract-sclm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,sclm-method} 4 | \alias{extract,sclm-method} 5 | \alias{extract.sclm} 6 | \title{\code{\link{extract}} method for \code{sclm} objects} 7 | \usage{ 8 | \S4method{extract}{sclm}( 9 | model, 10 | include.thresholds = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.thresholds}{Report thresholds in the GOF block?} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 27 | block?} 28 | 29 | \item{include.loglik}{Report the log likelihood in the GOF block?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{sclm} objects created by the 38 | \code{\link[ordinal]{clm}} function in the \pkg{ordinal} package. 39 | } 40 | -------------------------------------------------------------------------------- /tests/testthat/test-huxtablereg.R: -------------------------------------------------------------------------------- 1 | context("huxtablereg") 2 | suppressPackageStartupMessages(library("texreg")) 3 | 4 | skip_if_not_installed("huxtable") 5 | 6 | library("huxtable") 7 | 8 | m1 <- lm(mpg ~ gear, mtcars) 9 | m2 <- lm(mpg ~ gear + cyl, mtcars) 10 | 11 | test_that("huxtablereg gives useful error message if huxtable not installed", { 12 | skip_if_not_installed("huxtable", minimum_version = "5.0.0") 13 | with_mocked_bindings(requireNamespace = function (...) return(FALSE), { 14 | expect_error(huxtablereg(list(m1, m2)), regex = "huxtable") 15 | }) 16 | }) 17 | 18 | test_that("huxtablereg works", { 19 | skip_if_not_installed("huxtable", minimum_version = "5.0.0") 20 | expect_equivalent(dim(as.data.frame(huxtablereg(list(m1, m2)))), c(10, 3)) 21 | }) 22 | 23 | test_that("huxtablereg works with beside = TRUE", { 24 | skip_if_not_installed("huxtable", minimum_version = "5.0.0") 25 | skip_if_not_installed("systemfit") 26 | 27 | library(systemfit) 28 | data("Kmenta") 29 | eqDemand <- consump ~ price + income 30 | eqSupply <- consump ~ price + farmPrice + trend 31 | system <- list(demand = eqDemand, supply = eqSupply) 32 | fitols <- systemfit(system, data = Kmenta) 33 | 34 | h <- huxtablereg(fitols, beside = TRUE) 35 | expect_equal(ncol(h), 3) 36 | }) 37 | -------------------------------------------------------------------------------- /man/extract-survreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,survreg-method} 4 | \alias{extract,survreg-method} 5 | \alias{extract.survreg} 6 | \title{\code{\link{extract}} method for \code{survreg} objects} 7 | \usage{ 8 | \S4method{extract}{survreg}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 25 | block?} 26 | 27 | \item{include.loglik}{Report the log likelihood in the GOF block?} 28 | 29 | \item{include.deviance}{Report the deviance?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{survreg} objects created by the 38 | \code{\link[survival]{survreg}} function in the \pkg{survival} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-speedglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,speedglm-method} 4 | \alias{extract,speedglm-method} 5 | \alias{extract.speedglm} 6 | \title{\code{\link{extract}} method for \code{speedglm} objects} 7 | \usage{ 8 | \S4method{extract}{speedglm}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 25 | block?} 26 | 27 | \item{include.loglik}{Report the log likelihood in the GOF block?} 28 | 29 | \item{include.deviance}{Report the deviance?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{speedglm} objects created by the 38 | \code{\link[speedglm]{speedglm}} function in the \pkg{speedglm} 39 | package. 40 | } 41 | -------------------------------------------------------------------------------- /man/extract-feis-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,feis-method} 4 | \alias{extract,feis-method} 5 | \alias{extract.feis} 6 | \title{\code{\link{extract}} method for \code{feis} objects} 7 | \usage{ 8 | \S4method{extract}{feis}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.groups = TRUE, 14 | include.rmse = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{include.groups}{Report the number of groups?} 28 | 29 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 30 | standard deviation) in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines, in this 33 | case to the \code{summary} method for the object.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{feis} objects created by the 37 | \code{\link[feisr]{feis}} function in the \pkg{feisr} package. 38 | } 39 | \author{ 40 | Tobias Rüttenauer, Philip Leifeld 41 | } 42 | -------------------------------------------------------------------------------- /man/extract-speedlm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,speedlm-method} 4 | \alias{extract,speedlm-method} 5 | \alias{extract.speedlm} 6 | \title{\code{\link{extract}} method for \code{speedlm} objects} 7 | \usage{ 8 | \S4method{extract}{speedlm}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.rmse = FALSE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 28 | 29 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 30 | standard deviation) in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines, in this 33 | case to the \code{summary} method for the object.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{speedlm} objects created by the 37 | \code{\link[speedglm]{speedlm}} function in the \pkg{speedglm} 38 | package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-phreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,phreg-method} 4 | \alias{extract,phreg-method} 5 | \alias{extract.phreg} 6 | \title{\code{\link{extract}} method for \code{phreg} objects} 7 | \usage{ 8 | \S4method{extract}{phreg}( 9 | model, 10 | include.aic = TRUE, 11 | include.loglik = TRUE, 12 | include.lr = TRUE, 13 | include.nobs = TRUE, 14 | include.events = TRUE, 15 | include.trisk = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.loglik}{Report the log likelihood in the GOF block?} 26 | 27 | \item{include.lr}{Report likelihood ratio test?} 28 | 29 | \item{include.nobs}{Report the number of observations in the GOF block?} 30 | 31 | \item{include.events}{Report the number of events in the GOF block?} 32 | 33 | \item{include.trisk}{Report the total time at risk (in event-history models)?} 34 | 35 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 36 | not in use.} 37 | } 38 | \description{ 39 | \code{\link{extract}} method for \code{phreg} objects created by the 40 | \code{\link[eha]{phreg}} function in the \pkg{eha} package. 41 | } 42 | -------------------------------------------------------------------------------- /man/extract-aftreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,aftreg-method} 4 | \alias{extract,aftreg-method} 5 | \alias{extract.aftreg} 6 | \title{\code{\link{extract}} method for \code{aftreg} objects} 7 | \usage{ 8 | \S4method{extract}{aftreg}( 9 | model, 10 | include.aic = TRUE, 11 | include.loglik = TRUE, 12 | include.lr = TRUE, 13 | include.nobs = TRUE, 14 | include.events = TRUE, 15 | include.trisk = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.loglik}{Report the log likelihood in the GOF block?} 26 | 27 | \item{include.lr}{Report likelihood ratio test?} 28 | 29 | \item{include.nobs}{Report the number of observations in the GOF block?} 30 | 31 | \item{include.events}{Report the number of events in the GOF block?} 32 | 33 | \item{include.trisk}{Report the total time at risk (in event-history models)?} 34 | 35 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 36 | not in use.} 37 | } 38 | \description{ 39 | \code{\link{extract}} method for \code{aftreg} objects created by the 40 | \code{\link[eha]{aftreg}} function in the \pkg{eha} package. 41 | } 42 | -------------------------------------------------------------------------------- /man/extract-coxreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,coxreg-method} 4 | \alias{extract,coxreg-method} 5 | \alias{extract.coxreg} 6 | \title{\code{\link{extract}} method for \code{coxreg} objects} 7 | \usage{ 8 | \S4method{extract}{coxreg}( 9 | model, 10 | include.aic = TRUE, 11 | include.loglik = TRUE, 12 | include.lr = TRUE, 13 | include.nobs = TRUE, 14 | include.events = TRUE, 15 | include.trisk = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.loglik}{Report the log likelihood in the GOF block?} 26 | 27 | \item{include.lr}{Report likelihood ratio test?} 28 | 29 | \item{include.nobs}{Report the number of observations in the GOF block?} 30 | 31 | \item{include.events}{Report the number of events in the GOF block?} 32 | 33 | \item{include.trisk}{Report the total time at risk (in event-history models)?} 34 | 35 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 36 | not in use.} 37 | } 38 | \description{ 39 | \code{\link{extract}} method for \code{coxreg} objects created by the 40 | \code{\link[eha]{coxreg}} function in the \pkg{eha} package. 41 | } 42 | -------------------------------------------------------------------------------- /man/extract-survreg.penal-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,survreg.penal-method} 4 | \alias{extract,survreg.penal-method} 5 | \alias{extract.survreg.penal} 6 | \title{\code{\link{extract}} method for \code{survreg.penal} objects} 7 | \usage{ 8 | \S4method{extract}{survreg.penal}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 25 | block?} 26 | 27 | \item{include.loglik}{Report the log likelihood in the GOF block?} 28 | 29 | \item{include.deviance}{Report the deviance?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{survreg.penal} objects created by the 38 | \code{\link[survival]{survreg}} function in the \pkg{survival} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-lmrob-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lmrob-method} 4 | \alias{extract,lmrob-method} 5 | \alias{extract.lmrob} 6 | \alias{extract,lmRob-method} 7 | \alias{extract.lmRob} 8 | \title{\code{\link{extract}} method for \code{lmrob} objects} 9 | \usage{ 10 | \S4method{extract}{lmrob}(model, include.nobs = TRUE, ...) 11 | 12 | \S4method{extract}{lmRob}( 13 | model, 14 | include.rsquared = TRUE, 15 | include.nobs = TRUE, 16 | include.rmse = TRUE, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{model}{A statistical model object.} 22 | 23 | \item{include.nobs}{Report the number of observations in the GOF block?} 24 | 25 | \item{...}{Custom parameters, which are handed over to subroutines, in this 26 | case to the \code{summary} method for the object.} 27 | 28 | \item{include.rsquared}{Report R^2 in the GOF block?} 29 | 30 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 31 | standard deviation) in the GOF block?} 32 | } 33 | \description{ 34 | \code{\link{extract}} method for \code{lmrob} objects created by the 35 | \code{lmrob} function in the \pkg{robustbase} package. 36 | 37 | \code{\link{extract}} method for \code{lmRob} objects created by the 38 | \code{\link[robust]{lmRob}} function in the \pkg{robust} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-summary.lm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,summary.lm-method} 4 | \alias{extract,summary.lm-method} 5 | \alias{extract.summary.lm} 6 | \title{\code{\link{extract}} method for \code{summary.lm} objects} 7 | \usage{ 8 | \S4method{extract}{summary.lm}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.rmse = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 28 | 29 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 30 | standard deviation) in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 33 | not in use.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{summary.lm} objects created by the 37 | \code{summary} method for \code{lm} objects, defined in the \pkg{stats} 38 | package (see \code{\link[stats]{summary.lm}}). 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-weibreg-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,weibreg-method} 4 | \alias{extract,weibreg-method} 5 | \alias{extract.weibreg} 6 | \title{\code{\link{extract}} method for \code{weibreg} objects} 7 | \usage{ 8 | \S4method{extract}{weibreg}( 9 | model, 10 | include.aic = TRUE, 11 | include.loglik = TRUE, 12 | include.lr = TRUE, 13 | include.nobs = TRUE, 14 | include.events = TRUE, 15 | include.trisk = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.loglik}{Report the log likelihood in the GOF block?} 26 | 27 | \item{include.lr}{Report likelihood ratio test?} 28 | 29 | \item{include.nobs}{Report the number of observations in the GOF block?} 30 | 31 | \item{include.events}{Report the number of events in the GOF block?} 32 | 33 | \item{include.trisk}{Report the total time at risk (in event-history models)?} 34 | 35 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 36 | not in use.} 37 | } 38 | \description{ 39 | \code{\link{extract}} method for \code{weibreg} objects created by the 40 | \code{\link[eha]{weibreg}} function in the \pkg{eha} package. 41 | } 42 | -------------------------------------------------------------------------------- /man/extract-lme-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lme-method} 4 | \alias{extract,lme-method} 5 | \alias{extract.lme} 6 | \title{\code{\link{extract}} method for \code{lme} objects} 7 | \usage{ 8 | \S4method{extract}{lme}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | include.groups = TRUE, 15 | include.variance = FALSE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 26 | block?} 27 | 28 | \item{include.loglik}{Report the log likelihood in the GOF block?} 29 | 30 | \item{include.nobs}{Report the number of observations in the GOF block?} 31 | 32 | \item{include.groups}{Report the number of groups?} 33 | 34 | \item{include.variance}{Report group variances?} 35 | 36 | \item{...}{Custom parameters, which are handed over to subroutines, in this 37 | case to the \code{summary} method for the object.} 38 | } 39 | \description{ 40 | \code{\link{extract}} method for \code{lme} objects created by the 41 | \code{\link[nlme]{lme}} function in the \pkg{nlme} package. 42 | } 43 | -------------------------------------------------------------------------------- /man/extract-lm.cluster-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lm.cluster-method} 4 | \alias{extract,lm.cluster-method} 5 | \alias{extract.lm.cluster} 6 | \title{\code{\link{extract}} method for \code{lm.cluster} objects} 7 | \usage{ 8 | \S4method{extract}{lm.cluster}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.rmse = FALSE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 28 | 29 | \item{include.rmse}{Report the root mean square error (RMSE; = residual 30 | standard deviation) in the GOF block?} 31 | 32 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 33 | not in use.} 34 | } 35 | \description{ 36 | \code{\link{extract}} method for \code{lm.cluster} objects created by the 37 | \code{\link[miceadds]{lm.cluster}} function in the \pkg{miceadds} package. 38 | } 39 | \author{ 40 | Alexander Staudt, Philip Leifeld 41 | } 42 | -------------------------------------------------------------------------------- /man/extract-systemfit-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,systemfit-method} 4 | \alias{extract,systemfit-method} 5 | \alias{extract.systemfit} 6 | \title{\code{\link{extract}} method for \code{systemfit} objects} 7 | \usage{ 8 | \S4method{extract}{systemfit}( 9 | model, 10 | include.rsquared = TRUE, 11 | include.adjrs = TRUE, 12 | include.nobs = TRUE, 13 | beside = FALSE, 14 | include.suffix = FALSE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.rsquared}{Report R^2 in the GOF block?} 22 | 23 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 24 | 25 | \item{include.nobs}{Report the number of observations in the GOF block?} 26 | 27 | \item{beside}{Arrange the model terms below each other or beside each other, 28 | in separate columns?} 29 | 30 | \item{include.suffix}{Report the name of the current model in parentheses 31 | after each model term (instead of before the model term)?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines, in this 34 | case to the \code{summary} method for the object.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{systemfit} objects created by the 38 | \code{systemfit} function in the \pkg{systemfit} package. 39 | } 40 | -------------------------------------------------------------------------------- /man/extract-glm.cluster-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,glm.cluster-method} 4 | \alias{extract,glm.cluster-method} 5 | \alias{extract.glm.cluster} 6 | \title{\code{\link{extract}} method for \code{glm.cluster} objects} 7 | \usage{ 8 | \S4method{extract}{glm.cluster}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | ... 16 | ) 17 | } 18 | \arguments{ 19 | \item{model}{A statistical model object.} 20 | 21 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 22 | block?} 23 | 24 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 25 | block?} 26 | 27 | \item{include.loglik}{Report the log likelihood in the GOF block?} 28 | 29 | \item{include.deviance}{Report the deviance?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 34 | not in use.} 35 | } 36 | \description{ 37 | \code{\link{extract}} method for \code{glm.cluster} objects created by the 38 | \code{\link[miceadds:lm.cluster]{glm.cluster}} function in the \pkg{miceadds} package. 39 | } 40 | \author{ 41 | Alexander Staudt, Philip Leifeld 42 | } 43 | -------------------------------------------------------------------------------- /man/extract-nlme-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,nlme-method} 4 | \alias{extract,nlme-method} 5 | \alias{extract.nlme} 6 | \title{\code{\link{extract}} method for \code{nlme} objects} 7 | \usage{ 8 | \S4method{extract}{nlme}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | include.groups = TRUE, 15 | include.variance = FALSE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 26 | block?} 27 | 28 | \item{include.loglik}{Report the log likelihood in the GOF block?} 29 | 30 | \item{include.nobs}{Report the number of observations in the GOF block?} 31 | 32 | \item{include.groups}{Report the number of groups?} 33 | 34 | \item{include.variance}{Report group variances?} 35 | 36 | \item{...}{Custom parameters, which are handed over to subroutines, in this 37 | case to the \code{summary} method for the object.} 38 | } 39 | \description{ 40 | \code{\link{extract}} method for \code{nlme} objects created by the 41 | \code{\link[nlme]{nlme}} function in the \pkg{nlme} package. 42 | } 43 | -------------------------------------------------------------------------------- /man/extract-polr-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,polr-method} 4 | \alias{extract,polr-method} 5 | \alias{extract.polr} 6 | \title{\code{\link{extract}} method for \code{polr} objects} 7 | \usage{ 8 | \S4method{extract}{polr}( 9 | model, 10 | include.thresholds = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | include.deviance = TRUE, 15 | include.nobs = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.thresholds}{Report thresholds in the GOF block?} 23 | 24 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 25 | block?} 26 | 27 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 28 | block?} 29 | 30 | \item{include.loglik}{Report the log likelihood in the GOF block?} 31 | 32 | \item{include.deviance}{Report the deviance?} 33 | 34 | \item{include.nobs}{Report the number of observations in the GOF block?} 35 | 36 | \item{...}{Custom parameters, which are handed over to subroutines, in this 37 | case to the \code{summary} method for the object.} 38 | } 39 | \description{ 40 | \code{\link{extract}} method for \code{polr} objects created by the 41 | \code{\link[MASS]{polr}} function in the \pkg{MASS} package. 42 | } 43 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | # Generated by roxygen2: do not edit by hand 2 | 3 | S3method(print,texregTable) 4 | export(coeftostring) 5 | export(compute.width) 6 | export(createTexreg) 7 | export(customcolumnnames) 8 | export(extract) 9 | export(get.data) 10 | export(get_stars_note) 11 | export(htmlreg) 12 | export(huxtablereg) 13 | export(knitreg) 14 | export(matrixreg) 15 | export(names2latex) 16 | export(override) 17 | export(plotreg) 18 | export(praise) 19 | export(praise_interactive) 20 | export(screenreg) 21 | export(texreg) 22 | export(wordreg) 23 | exportClasses(texreg) 24 | exportMethods(extract) 25 | exportMethods(show) 26 | import(httr) 27 | import(stats) 28 | importFrom(methods,new) 29 | importFrom(methods,show) 30 | importFrom(stats,AIC) 31 | importFrom(stats,BIC) 32 | importFrom(stats,coef) 33 | importFrom(stats,confint) 34 | importFrom(stats,deviance) 35 | importFrom(stats,extractAIC) 36 | importFrom(stats,fitted) 37 | importFrom(stats,logLik) 38 | importFrom(stats,model.frame) 39 | importFrom(stats,na.omit) 40 | importFrom(stats,nobs) 41 | importFrom(stats,pchisq) 42 | importFrom(stats,pnorm) 43 | importFrom(stats,pt) 44 | importFrom(stats,residuals) 45 | importFrom(stats,summary.lm) 46 | importFrom(stats,vcov) 47 | importFrom(utils,capture.output) 48 | importFrom(utils,menu) 49 | importFrom(utils,methods) 50 | importFrom(utils,packageDescription) 51 | importFrom(utils,packageVersion) 52 | -------------------------------------------------------------------------------- /man/extract-svyglm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,svyglm-method} 4 | \alias{extract,svyglm-method} 5 | \alias{extract.svyglm} 6 | \title{\code{\link{extract}} method for \code{svyglm} objects} 7 | \usage{ 8 | \S4method{extract}{svyglm}( 9 | model, 10 | include.aic = FALSE, 11 | include.bic = FALSE, 12 | include.loglik = FALSE, 13 | include.deviance = TRUE, 14 | include.dispersion = TRUE, 15 | include.nobs = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 26 | block?} 27 | 28 | \item{include.loglik}{Report the log likelihood in the GOF block?} 29 | 30 | \item{include.deviance}{Report the deviance?} 31 | 32 | \item{include.dispersion}{Report the dispersion parameter?} 33 | 34 | \item{include.nobs}{Report the number of observations in the GOF block?} 35 | 36 | \item{...}{Custom parameters, which are handed over to subroutines, in this 37 | case to the \code{summary} method for the object.} 38 | } 39 | \description{ 40 | \code{\link{extract}} method for \code{svyglm} objects created by the 41 | \code{svyglm} function in the \pkg{survey} package. 42 | } 43 | -------------------------------------------------------------------------------- /man/extract-glmmPQL-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,glmmPQL-method} 4 | \alias{extract,glmmPQL-method} 5 | \alias{extract.glmmPQL} 6 | \title{\code{\link{extract}} method for \code{glmmPQL} objects} 7 | \usage{ 8 | \S4method{extract}{glmmPQL}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | include.groups = TRUE, 15 | include.variance = FALSE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 26 | block?} 27 | 28 | \item{include.loglik}{Report the log likelihood in the GOF block?} 29 | 30 | \item{include.nobs}{Report the number of observations in the GOF block?} 31 | 32 | \item{include.groups}{Report the number of groups?} 33 | 34 | \item{include.variance}{Report group variances?} 35 | 36 | \item{...}{Custom parameters, which are handed over to subroutines, in this 37 | case to the \code{summary} method for the object.} 38 | } 39 | \description{ 40 | \code{\link{extract}} method for \code{glmmPQL} objects created by the 41 | \code{\link[MASS]{glmmPQL}} function in the \pkg{MASS} package. 42 | } 43 | -------------------------------------------------------------------------------- /man/extract-forecast_ARIMA-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,forecast_ARIMA-method} 4 | \alias{extract,forecast_ARIMA-method} 5 | \alias{extract.forecast_ARIMA} 6 | \title{\code{\link{extract}} method for \code{forecast_ARIMA} objects} 7 | \usage{ 8 | \S4method{extract}{forecast_ARIMA}( 9 | model, 10 | include.pvalues = TRUE, 11 | include.aic = TRUE, 12 | include.aicc = TRUE, 13 | include.bic = TRUE, 14 | include.loglik = TRUE, 15 | include.nobs = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.pvalues}{Report p-values?} 23 | 24 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 25 | block?} 26 | 27 | \item{include.aicc}{Report AICC in the GOF block?} 28 | 29 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 30 | block?} 31 | 32 | \item{include.loglik}{Report the log likelihood in the GOF block?} 33 | 34 | \item{include.nobs}{Report the number of observations in the GOF block?} 35 | 36 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 37 | not in use.} 38 | } 39 | \description{ 40 | \code{\link{extract}} method for \code{forecast_ARIMA} objects created by the 41 | \code{\link[forecast]{Arima}} function in the \pkg{forecast} package. 42 | } 43 | -------------------------------------------------------------------------------- /man/extract-clogit-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,clogit-method} 4 | \alias{extract,clogit-method} 5 | \alias{extract.clogit} 6 | \title{\code{\link{extract}} method for \code{clogit} objects} 7 | \usage{ 8 | \S4method{extract}{clogit}( 9 | model, 10 | include.aic = TRUE, 11 | include.rsquared = TRUE, 12 | include.maxrs = TRUE, 13 | include.events = TRUE, 14 | include.nobs = TRUE, 15 | include.missings = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 23 | block?} 24 | 25 | \item{include.rsquared}{Report R^2 in the GOF block?} 26 | 27 | \item{include.maxrs}{Report maximal R^2 in the GOF block?} 28 | 29 | \item{include.events}{Report the number of events in the GOF block?} 30 | 31 | \item{include.nobs}{Report the number of observations in the GOF block?} 32 | 33 | \item{include.missings}{Report number of missing data points in the GOF 34 | block?} 35 | 36 | \item{...}{Custom parameters, which are handed over to subroutines, in this 37 | case to the \code{summary} method for the object.} 38 | } 39 | \description{ 40 | \code{\link{extract}} method for \code{clogit} objects created by the 41 | \code{\link[survival]{clogit}} function in the \pkg{survival} package. 42 | } 43 | -------------------------------------------------------------------------------- /man/extract-felm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,felm-method} 4 | \alias{extract,felm-method} 5 | \alias{extract.felm} 6 | \title{\code{\link{extract}} method for \code{felm} objects} 7 | \usage{ 8 | \S4method{extract}{felm}( 9 | model, 10 | include.nobs = TRUE, 11 | include.rsquared = TRUE, 12 | include.adjrs = TRUE, 13 | include.fstatistic = FALSE, 14 | include.proj.stats = TRUE, 15 | include.groups = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.nobs}{Report the number of observations in the GOF block?} 23 | 24 | \item{include.rsquared}{Report R^2 in the GOF block?} 25 | 26 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 27 | 28 | \item{include.fstatistic}{Report the F-statistic in the GOF block?} 29 | 30 | \item{include.proj.stats}{Include statistics for projected model in the GOF block?} 31 | 32 | \item{include.groups}{Report the number of groups?} 33 | 34 | \item{...}{Custom parameters, which are handed over to subroutines, in this 35 | case to the \code{summary} method for the object.} 36 | } 37 | \description{ 38 | \code{\link{extract}} method for \code{felm} objects created by the 39 | \code{\link[lfe]{felm}} function in the \pkg{lfe} package. 40 | } 41 | \author{ 42 | Christoph Riedl, Claudia Zucca, Oliver Reiter, Philip Leifeld 43 | } 44 | -------------------------------------------------------------------------------- /man/extract-clmm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,clmm-method} 4 | \alias{extract,clmm-method} 5 | \alias{extract.clmm} 6 | \title{\code{\link{extract}} method for \code{clmm} objects} 7 | \usage{ 8 | \S4method{extract}{clmm}( 9 | model, 10 | include.thresholds = TRUE, 11 | include.loglik = TRUE, 12 | include.aic = TRUE, 13 | include.bic = TRUE, 14 | include.nobs = TRUE, 15 | include.groups = TRUE, 16 | include.variance = TRUE, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{model}{A statistical model object.} 22 | 23 | \item{include.thresholds}{Report thresholds in the GOF block?} 24 | 25 | \item{include.loglik}{Report the log likelihood in the GOF block?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{include.nobs}{Report the number of observations in the GOF block?} 34 | 35 | \item{include.groups}{Report the number of groups?} 36 | 37 | \item{include.variance}{Report group variances?} 38 | 39 | \item{...}{Custom parameters, which are handed over to subroutines, in this 40 | case to the \code{summary} method for the object.} 41 | } 42 | \description{ 43 | \code{\link{extract}} method for \code{clmm} objects created by the 44 | \code{\link[ordinal]{clmm}} function in the \pkg{ordinal} package. 45 | } 46 | -------------------------------------------------------------------------------- /man/extract-remstimate-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,remstimate-method} 4 | \alias{extract,remstimate-method} 5 | \alias{extract.remstimate} 6 | \title{\code{\link{extract}} method for \code{remstimate} objects} 7 | \usage{ 8 | \S4method{extract}{remstimate}( 9 | model, 10 | include.nobs = TRUE, 11 | include.aic = TRUE, 12 | include.aicc = TRUE, 13 | include.bic = TRUE, 14 | include.loglik = TRUE, 15 | post.mean = FALSE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{include.nobs}{Report the number of observations in the GOF block?} 23 | 24 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 25 | block?} 26 | 27 | \item{include.aicc}{Report Corrected Akaike's Information Criterion (AICc) in 28 | the GOF block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{include.loglik}{Report the log likelihood in the GOF block?} 34 | 35 | \item{post.mean}{Report the posterior means, rather than the posterior modes, 36 | as coefficients?} 37 | 38 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 39 | not in use.} 40 | } 41 | \description{ 42 | \code{\link{extract}} method for \code{remstimate} objects created by the 43 | \code{\link[remstimate]{remstimate}} function in the \pkg{remstimate} 44 | package. 45 | } 46 | -------------------------------------------------------------------------------- /man/extract-mlogit-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,mlogit-method} 4 | \alias{extract,mlogit-method} 5 | \alias{extract.mlogit} 6 | \title{\code{\link{extract}} method for \code{mlogit} objects} 7 | \usage{ 8 | \S4method{extract}{mlogit}( 9 | model, 10 | include.aic = TRUE, 11 | include.loglik = TRUE, 12 | include.nobs = TRUE, 13 | include.groups = TRUE, 14 | include.order = FALSE, 15 | include.iterations = FALSE, 16 | beside = FALSE, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{model}{A statistical model object.} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.loglik}{Report the log likelihood in the GOF block?} 27 | 28 | \item{include.nobs}{Report the number of observations in the GOF block?} 29 | 30 | \item{include.groups}{Report the number of groups?} 31 | 32 | \item{include.order}{Report coefficient names in alphabetical order?} 33 | 34 | \item{include.iterations}{Report the number of iterations?} 35 | 36 | \item{beside}{Arrange the model terms below each other or beside each other?} 37 | 38 | \item{...}{Custom parameters, which are handed over to subroutines, in this 39 | case to the \code{summary} method for the object.} 40 | } 41 | \description{ 42 | \code{\link{extract}} method for \code{mlogit} objects created by the 43 | \code{\link[mlogit]{mlogit}} function in the \pkg{mlogit} package. 44 | } 45 | -------------------------------------------------------------------------------- /man/extract-gnm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gnm-method} 4 | \alias{extract,gnm-method} 5 | \alias{extract.gnm} 6 | \title{\code{\link{extract}} method for \code{gnm} objects} 7 | \usage{ 8 | \S4method{extract}{gnm}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = TRUE, 15 | include.df = FALSE, 16 | include.chisq = FALSE, 17 | include.delta = FALSE, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{model}{A statistical model object.} 23 | 24 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 25 | block?} 26 | 27 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 28 | block?} 29 | 30 | \item{include.loglik}{Report the log likelihood in the GOF block?} 31 | 32 | \item{include.deviance}{Report the deviance?} 33 | 34 | \item{include.nobs}{Report the number of observations in the GOF block?} 35 | 36 | \item{include.df}{Report the degrees of freedom?} 37 | 38 | \item{include.chisq}{Report the chi squared statistic?} 39 | 40 | \item{include.delta}{Report the delta statistic?} 41 | 42 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 43 | not in use.} 44 | } 45 | \description{ 46 | \code{\link{extract}} method for \code{gnm} objects created by the 47 | \code{\link[gnm]{gnm}} function in the \pkg{gnm} package. 48 | } 49 | -------------------------------------------------------------------------------- /man/extract-coxph-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,coxph-method} 4 | \alias{extract,coxph-method} 5 | \alias{extract.coxph} 6 | \title{\code{\link{extract}} method for \code{coxph} objects} 7 | \usage{ 8 | \S4method{extract}{coxph}( 9 | model, 10 | include.aic = TRUE, 11 | include.rsquared = TRUE, 12 | include.maxrs = TRUE, 13 | include.events = TRUE, 14 | include.nobs = TRUE, 15 | include.missings = TRUE, 16 | include.zph = TRUE, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{model}{A statistical model object.} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.rsquared}{Report R^2 in the GOF block?} 27 | 28 | \item{include.maxrs}{Report maximal R^2 in the GOF block?} 29 | 30 | \item{include.events}{Report the number of events in the GOF block?} 31 | 32 | \item{include.nobs}{Report the number of observations in the GOF block?} 33 | 34 | \item{include.missings}{Report number of missing data points in the GOF 35 | block?} 36 | 37 | \item{include.zph}{Report proportional hazard test in the GOF block?} 38 | 39 | \item{...}{Custom parameters, which are handed over to subroutines, in this 40 | case to the \code{summary} method for the object.} 41 | } 42 | \description{ 43 | \code{\link{extract}} method for \code{coxph} objects created by the 44 | \code{\link[survival]{coxph}} function in the \pkg{survival} package. 45 | } 46 | -------------------------------------------------------------------------------- /man/extract-tobit-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,tobit-method} 4 | \alias{extract,tobit-method} 5 | \alias{extract.tobit} 6 | \title{\code{\link{extract}} method for \code{tobit} objects} 7 | \usage{ 8 | \S4method{extract}{tobit}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.deviance = TRUE, 14 | include.nobs = FALSE, 15 | include.censnobs = TRUE, 16 | include.wald = TRUE, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{model}{A statistical model object.} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 27 | block?} 28 | 29 | \item{include.loglik}{Report the log likelihood in the GOF block?} 30 | 31 | \item{include.deviance}{Report the deviance?} 32 | 33 | \item{include.nobs}{Report the number of observations in the GOF block?} 34 | 35 | \item{include.censnobs}{Report the total, right-censored, left-censored, and 36 | uncensored number of observations?} 37 | 38 | \item{include.wald}{Report the Wald statistic?} 39 | 40 | \item{...}{Custom parameters, which are handed over to subroutines, in this 41 | case to the \code{summary} method for the object.} 42 | } 43 | \description{ 44 | \code{\link{extract}} method for \code{tobit} objects created by the 45 | \code{\link[AER]{tobit}} function in the \pkg{AER} package. 46 | } 47 | -------------------------------------------------------------------------------- /man/extract-coxph.penal-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,coxph.penal-method} 4 | \alias{extract,coxph.penal-method} 5 | \alias{extract.coxph.penal} 6 | \title{\code{\link{extract}} method for \code{coxph.penal} objects} 7 | \usage{ 8 | \S4method{extract}{coxph.penal}( 9 | model, 10 | include.aic = TRUE, 11 | include.rsquared = TRUE, 12 | include.maxrs = TRUE, 13 | include.events = TRUE, 14 | include.nobs = TRUE, 15 | include.missings = TRUE, 16 | include.zph = TRUE, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{model}{A statistical model object.} 22 | 23 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 24 | block?} 25 | 26 | \item{include.rsquared}{Report R^2 in the GOF block?} 27 | 28 | \item{include.maxrs}{Report maximal R^2 in the GOF block?} 29 | 30 | \item{include.events}{Report the number of events in the GOF block?} 31 | 32 | \item{include.nobs}{Report the number of observations in the GOF block?} 33 | 34 | \item{include.missings}{Report number of missing data points in the GOF 35 | block?} 36 | 37 | \item{include.zph}{Report proportional hazard test in the GOF block?} 38 | 39 | \item{...}{Custom parameters, which are handed over to subroutines, in this 40 | case to the \code{summary} method for the object.} 41 | } 42 | \description{ 43 | \code{\link{extract}} method for \code{coxph.penal} objects created by the 44 | \code{\link[survival]{coxph}} function in the \pkg{survival} package. 45 | } 46 | -------------------------------------------------------------------------------- /man/extract-lqmm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lqmm-method} 4 | \alias{extract,lqmm-method} 5 | \alias{extract.lqmm} 6 | \title{\code{\link{extract}} method for \code{lqmm} objects} 7 | \usage{ 8 | \S4method{extract}{lqmm}( 9 | model, 10 | include.aic = TRUE, 11 | include.bic = TRUE, 12 | include.loglik = TRUE, 13 | include.nobs = TRUE, 14 | include.groups = TRUE, 15 | include.tau = FALSE, 16 | use.ci = FALSE, 17 | beside = TRUE, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{model}{A statistical model object.} 23 | 24 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 25 | block?} 26 | 27 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 28 | block?} 29 | 30 | \item{include.loglik}{Report the log likelihood in the GOF block?} 31 | 32 | \item{include.nobs}{Report the number of observations in the GOF block?} 33 | 34 | \item{include.groups}{Report the number of groups?} 35 | 36 | \item{include.tau}{Report tau?} 37 | 38 | \item{use.ci}{Report confidence intervals in the GOF block?} 39 | 40 | \item{beside}{Arrange the model terms below each other or beside each other?} 41 | 42 | \item{...}{Custom parameters, which are handed over to subroutines, in this 43 | case to the \code{summary} method for the object.} 44 | } 45 | \description{ 46 | \code{\link{extract}} method for \code{lqmm} objects created by the 47 | \code{\link[lqmm]{lqmm}} function in the \pkg{lqmm} package. 48 | } 49 | -------------------------------------------------------------------------------- /man/extract-hurdle-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,hurdle-method} 4 | \alias{extract,hurdle-method} 5 | \alias{extract.hurdle} 6 | \title{\code{\link{extract}} method for \code{hurdle} objects} 7 | \usage{ 8 | \S4method{extract}{hurdle}( 9 | model, 10 | beside = FALSE, 11 | include.count = TRUE, 12 | include.zero = TRUE, 13 | include.aic = TRUE, 14 | include.loglik = TRUE, 15 | include.nobs = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{beside}{Arrange the model terms below each other or beside each other? 23 | The binary model parameters and the count parameters can be displayed in 24 | two separate columns of the table.} 25 | 26 | \item{include.count}{Report the count parameters in the coefficients block 27 | (before the binary part for the zeros)?} 28 | 29 | \item{include.zero}{Should the binary part of the model be included in the 30 | coefficients block (after the count parameters)?} 31 | 32 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 33 | block?} 34 | 35 | \item{include.loglik}{Report the log likelihood in the GOF block?} 36 | 37 | \item{include.nobs}{Report the number of observations in the GOF block?} 38 | 39 | \item{...}{Custom parameters, which are handed over to subroutines, in this 40 | case to the \code{summary} method for the object.} 41 | } 42 | \description{ 43 | \code{\link{extract}} method for \code{hurdle} objects created by the 44 | \code{hurdle} function in the \pkg{pscl} package. 45 | } 46 | -------------------------------------------------------------------------------- /man/extract-zeroinfl-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,zeroinfl-method} 4 | \alias{extract,zeroinfl-method} 5 | \alias{extract.zeroinfl} 6 | \title{\code{\link{extract}} method for \code{zeroinfl} objects} 7 | \usage{ 8 | \S4method{extract}{zeroinfl}( 9 | model, 10 | beside = FALSE, 11 | include.count = TRUE, 12 | include.zero = TRUE, 13 | include.aic = TRUE, 14 | include.loglik = TRUE, 15 | include.nobs = TRUE, 16 | ... 17 | ) 18 | } 19 | \arguments{ 20 | \item{model}{A statistical model object.} 21 | 22 | \item{beside}{Arrange the model terms below each other or beside each other? 23 | The binary model parameters and the count parameters can be displayed in 24 | two separate columns of the table.} 25 | 26 | \item{include.count}{Report the count parameters in the coefficients block 27 | (before the binary part for the zeros)?} 28 | 29 | \item{include.zero}{Should the binary part of the model be included in the 30 | coefficients block (after the count parameters)?} 31 | 32 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 33 | block?} 34 | 35 | \item{include.loglik}{Report the log likelihood in the GOF block?} 36 | 37 | \item{include.nobs}{Report the number of observations in the GOF block?} 38 | 39 | \item{...}{Custom parameters, which are handed over to subroutines, in this 40 | case to the \code{summary} method for the object.} 41 | } 42 | \description{ 43 | \code{\link{extract}} method for \code{zeroinfl} objects created by the 44 | \code{zeroinfl} function in the \pkg{pscl} package. 45 | } 46 | -------------------------------------------------------------------------------- /man/extract-glmmadmb-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,glmmadmb-method} 4 | \alias{extract,glmmadmb-method} 5 | \alias{extract.glmmadmb} 6 | \title{\code{\link{extract}} method for \code{glmmadmb} objects} 7 | \usage{ 8 | \S4method{extract}{glmmadmb}( 9 | model, 10 | include.variance = TRUE, 11 | include.dispersion = TRUE, 12 | include.zero = TRUE, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | include.loglik = TRUE, 16 | include.nobs = TRUE, 17 | include.groups = TRUE, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{model}{A statistical model object.} 23 | 24 | \item{include.variance}{Report group variances?} 25 | 26 | \item{include.dispersion}{Report the dispersion parameter?} 27 | 28 | \item{include.zero}{Should the binary part of a zero-inflated regression 29 | model or hurdle model be included in the coefficients block (after the 30 | count model)?} 31 | 32 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 33 | block?} 34 | 35 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 36 | block?} 37 | 38 | \item{include.loglik}{Report the log likelihood in the GOF block?} 39 | 40 | \item{include.nobs}{Report the number of observations in the GOF block?} 41 | 42 | \item{include.groups}{Report the number of groups?} 43 | 44 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 45 | not in use.} 46 | } 47 | \description{ 48 | \code{\link{extract}} method for \code{glmmadmb} objects created by the 49 | \code{glmmadmb} function in the \pkg{glmmADMB} package. 50 | } 51 | -------------------------------------------------------------------------------- /man/extract-H2OBinomialModel-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,H2OBinomialModel-method} 4 | \alias{extract,H2OBinomialModel-method} 5 | \alias{extract.H2OBinomialModel} 6 | \title{\code{\link{extract}} method for \code{H2OBinomialModel} objects} 7 | \usage{ 8 | \S4method{extract}{H2OBinomialModel}( 9 | model, 10 | standardized = FALSE, 11 | include.mse = TRUE, 12 | include.rsquared = TRUE, 13 | include.logloss = TRUE, 14 | include.meanerror = TRUE, 15 | include.auc = TRUE, 16 | include.gini = TRUE, 17 | include.deviance = TRUE, 18 | include.aic = TRUE, 19 | ... 20 | ) 21 | } 22 | \arguments{ 23 | \item{model}{A statistical model object.} 24 | 25 | \item{standardized}{Report standardized coefficients instead of raw 26 | coefficients?} 27 | 28 | \item{include.mse}{Report the mean squared error in the GOF block?} 29 | 30 | \item{include.rsquared}{Report R^2 in the GOF block?} 31 | 32 | \item{include.logloss}{Report the log loss?} 33 | 34 | \item{include.meanerror}{Report the mean per-class error?} 35 | 36 | \item{include.auc}{Report the area under the curve (AUC)?} 37 | 38 | \item{include.gini}{Report the Gini coefficient?} 39 | 40 | \item{include.deviance}{Report the deviance?} 41 | 42 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 43 | block?} 44 | 45 | \item{...}{Custom parameters, which are handed over to subroutines. Currently 46 | not in use.} 47 | } 48 | \description{ 49 | \code{\link{extract}} method for \code{H2OBinomialModel} objects created by 50 | the \code{\link[h2o]{h2o.glm}} function in the \pkg{h2o} package. 51 | } 52 | -------------------------------------------------------------------------------- /man/texreg-class.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \docType{class} 4 | \name{texreg-class} 5 | \alias{texreg-class} 6 | \title{An S4 class to represent a statistical model as a texreg object} 7 | \description{ 8 | An S4 class to represent a statistical model as a texreg object. 9 | } 10 | \details{ 11 | A \linkS4class{texreg} object stores details about a statistical model. It 12 | can be used for creating regression tables using \code{\link{screenreg}}, 13 | \code{\link{texreg}}, and similar functions. 14 | } 15 | \section{Slots}{ 16 | 17 | \describe{ 18 | \item{\code{coef.names}}{The covariate names.} 19 | 20 | \item{\code{coef}}{The coefficients.} 21 | 22 | \item{\code{se}}{The standard errors.} 23 | 24 | \item{\code{pvalues}}{The p-values.} 25 | 26 | \item{\code{ci.low}}{The lower bounds of the confidence intervals.} 27 | 28 | \item{\code{ci.up}}{The upper bounds of the confidence intervals.} 29 | 30 | \item{\code{gof.names}}{The names of the goodness-of-fit statistics.} 31 | 32 | \item{\code{gof}}{The goodness-of-fit statistics.} 33 | 34 | \item{\code{gof.decimal}}{A vector describing for each GOF statistic whether it is a 35 | decimal value (\code{TRUE}) or an integer value (\code{FALSE}).} 36 | 37 | \item{\code{model.name}}{An optional model name. Can be of length zero.} 38 | }} 39 | 40 | \references{ 41 | Leifeld, Philip (2013). texreg: Conversion of Statistical Model 42 | Output in R to LaTeX and HTML Tables. Journal of Statistical Software 43 | 55(8): 1-24. \doi{10.18637/jss.v055.i08}. 44 | } 45 | \seealso{ 46 | \code{\link{extract}} \code{\link{createTexreg}} 47 | } 48 | \author{ 49 | Philip Leifeld 50 | } 51 | -------------------------------------------------------------------------------- /man/extract-stergm-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,stergm-method} 4 | \alias{extract,stergm-method} 5 | \alias{extract.stergm} 6 | \title{\code{\link{extract}} method for \code{stergm} objects} 7 | \usage{ 8 | \S4method{extract}{stergm}( 9 | model, 10 | beside = FALSE, 11 | include.formation = TRUE, 12 | include.dissolution = TRUE, 13 | include.nvertices = TRUE, 14 | include.aic = FALSE, 15 | include.bic = FALSE, 16 | include.loglik = FALSE, 17 | ... 18 | ) 19 | } 20 | \arguments{ 21 | \item{model}{A statistical model object.} 22 | 23 | \item{beside}{Arrange the model terms below each other or beside each other? 24 | In a \code{stergm} model, the formation and dissolution coefficients can be 25 | arranged in two columns of the table.} 26 | 27 | \item{include.formation}{Report the coefficients for the formation process in 28 | a STERGM?} 29 | 30 | \item{include.dissolution}{Report the coefficients for the dissolution 31 | process in a STERGM?} 32 | 33 | \item{include.nvertices}{Report the number of vertices in a STERGM?} 34 | 35 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 36 | block?} 37 | 38 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 39 | block?} 40 | 41 | \item{include.loglik}{Report the log likelihood in the GOF block?} 42 | 43 | \item{...}{Custom parameters, which are handed over to subroutines, in this 44 | case to the \code{summary} method for the object.} 45 | } 46 | \description{ 47 | \code{\link{extract}} method for \code{stergm} objects created by the 48 | \code{stergm} function in the \pkg{tergm} package. 49 | } 50 | -------------------------------------------------------------------------------- /man/get_stars_note.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{get_stars_note} 4 | \alias{get_stars_note} 5 | \title{Create a legend for the stars in a regression table} 6 | \usage{ 7 | get_stars_note( 8 | stars = c(0.01, 0.05, 0.1), 9 | star.symbol = "*", 10 | symbol = ".", 11 | ci = FALSE, 12 | ci.test = NULL, 13 | output = "ascii" 14 | ) 15 | } 16 | \arguments{ 17 | \item{stars}{A numeric vector of cut-offs, with a maximum of four numbers.} 18 | 19 | \item{star.symbol}{The character to repeat for the first three levels of 20 | significance.} 21 | 22 | \item{symbol}{The character for the fourth level of significance.} 23 | 24 | \item{ci}{Confidence intervals instead of standard errors?} 25 | 26 | \item{ci.test}{The null hypothesis value, for example \code{0} (the normal 27 | case) or \code{1} (e.g., with exponentiated coefficients). A star is added 28 | if this value is outside the confidence interval.} 29 | 30 | \item{output}{The output type of the note. This can be \code{"ascii"}, 31 | \code{"latex"}, or \code{"html"}.} 32 | } 33 | \value{ 34 | A \code{character} string to be put below the regression table. It 35 | describes the thresholds for the significance stars. 36 | } 37 | \description{ 38 | Create a legend for the stars in a regression table. 39 | } 40 | \details{ 41 | This function creates a stars note as a legend to be placed below a 42 | regression table. The note contains the p-value or confidence interval 43 | significance levels and stars attached to them. 44 | } 45 | \seealso{ 46 | \code{\link{texreg}}, \code{\link{htmlreg}}, \code{\link{screenreg}} 47 | } 48 | \author{ 49 | Philip Leifeld 50 | } 51 | \keyword{internal} 52 | -------------------------------------------------------------------------------- /man/extract-fixest-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,fixest-method} 4 | \alias{extract,fixest-method} 5 | \alias{extract.fixest} 6 | \title{\code{\link{extract}} method for \code{fixest} objects} 7 | \usage{ 8 | \S4method{extract}{fixest}( 9 | model, 10 | include.nobs = TRUE, 11 | include.groups = TRUE, 12 | include.rsquared = TRUE, 13 | include.adjrs = TRUE, 14 | include.proj.stats = TRUE, 15 | include.deviance = TRUE, 16 | include.loglik = TRUE, 17 | include.pseudors = TRUE, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{model}{A statistical model object.} 23 | 24 | \item{include.nobs}{Report the number of observations?} 25 | 26 | \item{include.groups}{Report the number of groups?} 27 | 28 | \item{include.rsquared}{Report R^2? (OLS only)} 29 | 30 | \item{include.adjrs}{Report adjusted R^2? (OLS only)} 31 | 32 | \item{include.proj.stats}{Include statistics for projected model? (OLS only)} 33 | 34 | \item{include.deviance}{Report the deviance? (GLM/MLE only)} 35 | 36 | \item{include.loglik}{Report the log likelihood? (GLM/MLE only)} 37 | 38 | \item{include.pseudors}{Report Pseudo-R^2? (GLM/MLE only)} 39 | 40 | \item{...}{Custom parameters, which are handed over to the 41 | \code{\link[fixest]{coeftable}} method for the \code{fixest} object.} 42 | } 43 | \description{ 44 | \code{\link{extract}} method for \code{fixest} objects created by the 45 | model fitting functions in the \pkg{fixest} package. The method can deal with 46 | OLS (fitted by \code{\link[fixest]{feols}}) and GLM/MLE models (fitted by 47 | \code{\link[fixest]{feglm}} and other functions). 48 | } 49 | \author{ 50 | Christopher Poliquin, Philip Leifeld 51 | } 52 | -------------------------------------------------------------------------------- /man/extract-multinom-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,multinom-method} 4 | \alias{extract,multinom-method} 5 | \alias{extract.multinom} 6 | \title{\code{\link{extract}} method for \code{multinom} objects} 7 | \usage{ 8 | \S4method{extract}{multinom}( 9 | model, 10 | include.pvalues = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | include.deviance = TRUE, 15 | include.nobs = TRUE, 16 | include.groups = TRUE, 17 | levels = model$lev, 18 | beside = FALSE, 19 | ... 20 | ) 21 | } 22 | \arguments{ 23 | \item{model}{A statistical model object.} 24 | 25 | \item{include.pvalues}{Report p-values?} 26 | 27 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 28 | block?} 29 | 30 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 31 | block?} 32 | 33 | \item{include.loglik}{Report the log likelihood in the GOF block?} 34 | 35 | \item{include.deviance}{Report the deviance?} 36 | 37 | \item{include.nobs}{Report the number of observations in the GOF block?} 38 | 39 | \item{include.groups}{Report the number of groups?} 40 | 41 | \item{levels}{The names of the levels of a multinomial model that should be 42 | included in the table. Should be provided as a vector of character strings.} 43 | 44 | \item{beside}{Arrange the model terms below each other or beside each other?} 45 | 46 | \item{...}{Custom parameters, which are handed over to subroutines, in this 47 | case to the \code{summary} method for the object.} 48 | } 49 | \description{ 50 | \code{\link{extract}} method for \code{multinom} objects created by the 51 | \code{\link[nnet]{multinom}} function in the \pkg{nnet} package. 52 | } 53 | -------------------------------------------------------------------------------- /man/customcolumnnames.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{customcolumnnames} 4 | \alias{customcolumnnames} 5 | \title{Determine column names or column types if custom columns are present} 6 | \usage{ 7 | customcolumnnames(modelnames, custom.columns, custom.col.pos, types = FALSE) 8 | } 9 | \arguments{ 10 | \item{modelnames}{A \code{character} vector of original model names, before 11 | any custom columns are inserted.} 12 | 13 | \item{custom.columns}{The same argument as specified in the 14 | \code{link{matrixreg}} function.} 15 | 16 | \item{custom.col.pos}{The same argument as specified in the 17 | \code{link{matrixreg}} function.} 18 | 19 | \item{types}{Return the column types? If \code{FALSE}, the column names in 20 | the possible presence of custom columns are returned.} 21 | } 22 | \value{ 23 | A \code{character} vector with column names or types in the possible 24 | presence of custom columns. If \code{types = TRUE}, the vector contains 25 | the values \code{"coefnames"} (for the first column), \code{"coef"} (for 26 | columns with coefficients), or \code{"customcol"} (for custom new columns). 27 | } 28 | \description{ 29 | Determine column names or column types if custom columns are present. 30 | } 31 | \details{ 32 | This function takes model names (as saved in the attributes of a matrix 33 | generated by \code{\link{matrixreg}}, for example) and the 34 | \code{custom.columns} and \code{custom.col.pos} arguments of 35 | \code{link{matrixreg}} or related functions and determines the column types 36 | (\code{"coefnames"}, \code{"coef"}, or \code{"customcol"}) or model names in 37 | the presence of custom columns. 38 | } 39 | \seealso{ 40 | \code{\link{matrixreg}} 41 | } 42 | \author{ 43 | Philip Leifeld 44 | } 45 | \keyword{internal} 46 | -------------------------------------------------------------------------------- /man/override.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{override} 4 | \alias{override} 5 | \title{Replace coefs, SEs, p-values, and/or CIs by custom values if provided} 6 | \usage{ 7 | override( 8 | models, 9 | override.coef = 0, 10 | override.se = 0, 11 | override.pvalues = 0, 12 | override.ci.low = 0, 13 | override.ci.up = 0 14 | ) 15 | } 16 | \arguments{ 17 | \item{models}{A list of \linkS4class{texreg} objects (e.g., as returned by 18 | \code{\link{get.data}}).} 19 | 20 | \item{override.coef}{Replacement list of coefficient vectors.} 21 | 22 | \item{override.se}{Replacement list of standard error vectors} 23 | 24 | \item{override.pvalues}{Replacement list of p-value vectors.} 25 | 26 | \item{override.ci.low}{Replacement list of lower-bound confidence interval 27 | values.} 28 | 29 | \item{override.ci.up}{Replacement list of upper-bound confidence interval 30 | values.} 31 | } 32 | \value{ 33 | Same list as input list of models, but with replaced values. 34 | } 35 | \description{ 36 | Replace coefs, SEs, p-values, and/or CIs by custom values if provided. 37 | } 38 | \details{ 39 | This function replaces coefficients, standard errors, p-values, and/or 40 | confidence intervals in a list of \linkS4class{texreg} objects. It is used by 41 | the \code{\link{matrixreg}} and \code{\link{plotreg}} functions. The new 42 | values must be provided as lists of equal length as the list of models, with 43 | each element representing a vector of replacement values. If the arguments 44 | have value \code{0}, the original values are retained. More details are found 45 | in the documentation of the \code{\link{matrixreg}} function. 46 | } 47 | \seealso{ 48 | \code{\link{matrixreg}}, \code{\link{plotreg}}, \code{\link{texreg}} 49 | } 50 | \author{ 51 | Philip Leifeld 52 | } 53 | \keyword{internal} 54 | -------------------------------------------------------------------------------- /man/extract-glmmTMB-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,glmmTMB-method} 4 | \alias{extract,glmmTMB-method} 5 | \alias{extract.glmmTMB} 6 | \title{\code{\link{extract}} method for \code{glmmTMB} objects} 7 | \usage{ 8 | \S4method{extract}{glmmTMB}( 9 | model, 10 | beside = FALSE, 11 | include.count = TRUE, 12 | include.zero = TRUE, 13 | include.aic = TRUE, 14 | include.groups = TRUE, 15 | include.variance = TRUE, 16 | include.loglik = TRUE, 17 | include.nobs = TRUE, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{model}{A statistical model object.} 23 | 24 | \item{beside}{Arrange the model terms below each other or beside each other? 25 | The binary model parameters and the count parameters can be displayed in 26 | two separate columns of the table.} 27 | 28 | \item{include.count}{Report the count parameters in the coefficients block 29 | (before the binary part for the zeros)?} 30 | 31 | \item{include.zero}{Should the binary part of the model be included in the 32 | coefficients block (after the count parameters)?} 33 | 34 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 35 | block?} 36 | 37 | \item{include.groups}{Report the number of groups?} 38 | 39 | \item{include.variance}{Report group variances?} 40 | 41 | \item{include.loglik}{Report the log likelihood in the GOF block?} 42 | 43 | \item{include.nobs}{Report the number of observations in the GOF block?} 44 | 45 | \item{...}{Custom parameters, which are handed over to subroutines, in this 46 | case to the \code{summary} method for the object.} 47 | } 48 | \description{ 49 | \code{\link{extract}} method for \code{glmmTMB} objects created by the 50 | \code{\link[glmmTMB]{glmmTMB}} function in the \pkg{glmmTMB} package. 51 | } 52 | \author{ 53 | Ricardo Graiff Garcia, Philip Leifeld 54 | } 55 | -------------------------------------------------------------------------------- /man/compute.width.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{compute.width} 4 | \alias{compute.width} 5 | \title{Compute maximum column width left and right of a decimal separator} 6 | \usage{ 7 | compute.width(v, left = TRUE, single.row = FALSE, bracket = ")") 8 | } 9 | \arguments{ 10 | \item{v}{A \code{character} vector representing a column in a regression 11 | table.} 12 | 13 | \item{left}{Should the width left of the separator/bracket be calculated? If 14 | \code{FALSE}, the width right of the separator/bracket is computed.} 15 | 16 | \item{single.row}{Was the \code{single.row} argument used to construct the 17 | regression table? I.e., are both the coefficient and uncertainty measure 18 | (SE or CI) in the same rows of the matrix?} 19 | 20 | \item{bracket}{The separator symbol to match. These can be closing 21 | parentheses (in the case of standard errors when \code{single.row} is 22 | switched on), closing square brackets (in the case of confidence 23 | intervals), or dots (in the case of \code{single.row = FALSE}, for decimal 24 | alignment at the actual decimal separator).} 25 | } 26 | \value{ 27 | A number indicating the maximal width left or right of the separator. 28 | } 29 | \description{ 30 | Compute maximum column width left and right of a decimal separator. 31 | } 32 | \details{ 33 | This function takes a vector of \code{character} objects with coefficients, 34 | usually a column of a regression table, and computes the maximal width left 35 | or right of the decimal separator or bracket at which the cells are aligned 36 | vertically. This is useful in the context of the \code{\link{texreg}} 37 | function when the \code{dcolumn} or \code{siunitx} arguments are used for 38 | vertical decimal point alignment. 39 | } 40 | \seealso{ 41 | \code{\link{texreg}} 42 | } 43 | \author{ 44 | Philip Leifeld 45 | } 46 | \keyword{internal} 47 | -------------------------------------------------------------------------------- /man/extract-selection-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,selection-method} 4 | \alias{extract,selection-method} 5 | \alias{extract.selection} 6 | \title{\code{\link{extract}} method for \code{selection} objects} 7 | \usage{ 8 | \S4method{extract}{selection}( 9 | model, 10 | prefix = TRUE, 11 | include.selection = TRUE, 12 | include.outcome = TRUE, 13 | include.errors = TRUE, 14 | include.aic = TRUE, 15 | include.bic = TRUE, 16 | include.loglik = TRUE, 17 | include.rsquared = TRUE, 18 | include.adjrs = TRUE, 19 | include.nobs = TRUE, 20 | ... 21 | ) 22 | } 23 | \arguments{ 24 | \item{model}{A statistical model object.} 25 | 26 | \item{prefix}{Include prefix before the label of the coefficient in order to 27 | identify the current model component?} 28 | 29 | \item{include.selection}{Report the selection component of a sample selection 30 | model?} 31 | 32 | \item{include.outcome}{Report the outcome component of a sample selection 33 | model?} 34 | 35 | \item{include.errors}{Report the error terms of a sample selection model?} 36 | 37 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF} 38 | 39 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 40 | block?} 41 | 42 | \item{include.loglik}{Report the log likelihood in the GOF block?} 43 | 44 | \item{include.rsquared}{Report R^2 in the GOF block?} 45 | 46 | \item{include.adjrs}{Report adjusted R^2 in the GOF block?} 47 | 48 | \item{include.nobs}{Report the number of observations in the GOF block? 49 | block?} 50 | 51 | \item{...}{Custom parameters, which are handed over to subroutines, in this 52 | case to the \code{summary} method for the object.} 53 | } 54 | \description{ 55 | \code{\link{extract}} method for \code{selection} objects created by the 56 | \code{selection} function in the \pkg{sampleSelection} package. 57 | } 58 | -------------------------------------------------------------------------------- /man/extract-bam-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,bam-method} 4 | \alias{extract,bam-method} 5 | \alias{extract.bam} 6 | \title{\code{\link{extract}} method for \code{bam} objects} 7 | \usage{ 8 | \S4method{extract}{bam}( 9 | model, 10 | include.smooth = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | include.deviance = TRUE, 15 | include.dev.expl = TRUE, 16 | include.dispersion = TRUE, 17 | include.rsquared = TRUE, 18 | include.gcv = TRUE, 19 | include.nobs = TRUE, 20 | include.nsmooth = TRUE, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{model}{A statistical model object.} 26 | 27 | \item{include.smooth}{Report the smooth terms of a GAM? If they are 28 | reported, the EDF value is reported as the coefficient, and DF is included 29 | in parentheses (not standard errors because a chi-square test is used for 30 | the smooth terms).} 31 | 32 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 33 | block?} 34 | 35 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 36 | block?} 37 | 38 | \item{include.loglik}{Report the log likelihood in the GOF block?} 39 | 40 | \item{include.deviance}{Report the deviance?} 41 | 42 | \item{include.dev.expl}{Report the deviance explained?} 43 | 44 | \item{include.dispersion}{Report the dispersion parameter?} 45 | 46 | \item{include.rsquared}{Report R^2 in the GOF block?} 47 | 48 | \item{include.gcv}{Report the GCV score?} 49 | 50 | \item{include.nobs}{Report the number of observations in the GOF block?} 51 | 52 | \item{include.nsmooth}{Report the number of smooth terms?} 53 | 54 | \item{...}{Custom parameters, which are handed over to subroutines, in this 55 | case to the \code{summary} method for the object.} 56 | } 57 | \description{ 58 | \code{\link{extract}} method for \code{bam} objects created by the 59 | \code{\link[mgcv]{bam}} function in the \pkg{mgcv} package. 60 | } 61 | -------------------------------------------------------------------------------- /man/extract-gam-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,gam-method} 4 | \alias{extract,gam-method} 5 | \alias{extract.gam} 6 | \title{\code{\link{extract}} method for \code{gam} objects} 7 | \usage{ 8 | \S4method{extract}{gam}( 9 | model, 10 | include.smooth = TRUE, 11 | include.aic = TRUE, 12 | include.bic = TRUE, 13 | include.loglik = TRUE, 14 | include.deviance = TRUE, 15 | include.dev.expl = TRUE, 16 | include.dispersion = TRUE, 17 | include.rsquared = TRUE, 18 | include.gcv = TRUE, 19 | include.nobs = TRUE, 20 | include.nsmooth = TRUE, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{model}{A statistical model object.} 26 | 27 | \item{include.smooth}{Report the smooth terms of a GAM? If they are 28 | reported, the EDF value is reported as the coefficient, and DF is included 29 | in parentheses (not standard errors because a chi-square test is used for 30 | the smooth terms).} 31 | 32 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 33 | block?} 34 | 35 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 36 | block?} 37 | 38 | \item{include.loglik}{Report the log likelihood in the GOF block?} 39 | 40 | \item{include.deviance}{Report the deviance?} 41 | 42 | \item{include.dev.expl}{Report the deviance explained?} 43 | 44 | \item{include.dispersion}{Report the dispersion parameter?} 45 | 46 | \item{include.rsquared}{Report R^2 in the GOF block?} 47 | 48 | \item{include.gcv}{Report the GCV score?} 49 | 50 | \item{include.nobs}{Report the number of observations in the GOF block?} 51 | 52 | \item{include.nsmooth}{Report the number of smooth terms?} 53 | 54 | \item{...}{Custom parameters, which are handed over to subroutines, in this 55 | case to the \code{summary} method for the object.} 56 | } 57 | \description{ 58 | \code{\link{extract}} method for \code{gam} objects created by the 59 | \code{\link[mgcv]{gam}} function in the \pkg{mgcv} package. 60 | } 61 | -------------------------------------------------------------------------------- /man/extract-brmsfit-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,brmsfit-method} 4 | \alias{extract,brmsfit-method} 5 | \alias{extract.brmsfit} 6 | \title{\code{\link{extract}} method for \code{brmsfit} objects} 7 | \usage{ 8 | \S4method{extract}{brmsfit}( 9 | model, 10 | use.HDI = TRUE, 11 | level = 0.9, 12 | include.random = TRUE, 13 | include.rsquared = TRUE, 14 | include.nobs = TRUE, 15 | include.loo.ic = TRUE, 16 | reloo = FALSE, 17 | include.waic = TRUE, 18 | ... 19 | ) 20 | } 21 | \arguments{ 22 | \item{model}{A statistical model object.} 23 | 24 | \item{use.HDI}{Report highest posterior density (HPD) intervals (HDI) using 25 | the \code{\link[coda]{HPDinterval}} function in the \pkg{coda} package, 26 | with the probability given in the \code{level} argument, instead of the 27 | default 95 percent posterior quantiles?} 28 | 29 | \item{level}{Significance level (\code{1 - alpha}) for HPDs (in combination 30 | with the \code{use.HDI} argument).} 31 | 32 | \item{include.random}{Include random effects (standard deviations) in the GOF 33 | block of the table?} 34 | 35 | \item{include.rsquared}{Report R^2 in the GOF block?} 36 | 37 | \item{include.nobs}{Report the number of observations in the GOF block?} 38 | 39 | \item{include.loo.ic}{Report Leave-One-Out Information Criterion?} 40 | 41 | \item{reloo}{Recompute exact cross-validation for problematic observations 42 | for which approximate leave-one-out cross-validation may return incorrect 43 | results? This is done using the \code{\link[brms]{reloo.brmsfit}} function 44 | and may take some time to compute.} 45 | 46 | \item{include.waic}{Report Widely Applicable Information Criterion (WAIC)?} 47 | 48 | \item{...}{Custom parameters, which are handed over to subroutines, in this 49 | case to the \code{summary} method for the object.} 50 | } 51 | \description{ 52 | \code{\link{extract}} method for \code{brmsfit} objects created by the 53 | \code{\link[brms]{brm}} function in the \pkg{brms} package. 54 | } 55 | \author{ 56 | Hyunjin (Jin) Song, Philip Leifeld 57 | } 58 | -------------------------------------------------------------------------------- /man/extract-lme4-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lme4-method} 4 | \alias{extract,lme4-method} 5 | \alias{extract.lme4} 6 | \title{\code{\link{extract}} method for \code{lme4} objects} 7 | \usage{ 8 | \S4method{extract}{lme4}( 9 | model, 10 | method = c("naive", "profile", "boot", "Wald"), 11 | level = 0.95, 12 | nsim = 1000, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | include.dic = FALSE, 16 | include.deviance = FALSE, 17 | include.loglik = TRUE, 18 | include.nobs = TRUE, 19 | include.groups = TRUE, 20 | include.variance = TRUE, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{model}{A statistical model object.} 26 | 27 | \item{method}{The method used to compute confidence intervals or p-values. 28 | The default value \code{"naive"} computes naive p-values while the other 29 | methods compute confidence intervals using the \code{confint} function. See 30 | \code{\link[lme4]{confint.merMod}}.} 31 | 32 | \item{level}{Significance or confidence level (\code{1 - alpha}) for 33 | computing confidence intervals.} 34 | 35 | \item{nsim}{The MCMC sample size or number of bootstrapping replications on 36 | the basis of which confidence intervals are computed (only if the 37 | \code{method} argument does not specify \code{"naive"}, which is the 38 | default behavior). Note: large values may take considerable computing time.} 39 | 40 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 41 | block?} 42 | 43 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 44 | block?} 45 | 46 | \item{include.dic}{Report the deviance information criterion (DIC)?} 47 | 48 | \item{include.deviance}{Report the deviance?} 49 | 50 | \item{include.loglik}{Report the log likelihood in the GOF block?} 51 | 52 | \item{include.nobs}{Report the number of observations in the GOF block?} 53 | 54 | \item{include.groups}{Report the number of groups?} 55 | 56 | \item{include.variance}{Report group variances?} 57 | 58 | \item{...}{Arguments to be passed to the \code{\link[lme4]{fixef}} function 59 | in the \pkg{lme4} package.} 60 | } 61 | \description{ 62 | \code{\link{extract}} method for \code{lme4} objects created by the 63 | \pkg{lme4} package. 64 | } 65 | -------------------------------------------------------------------------------- /man/extract-merMod-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,merMod-method} 4 | \alias{extract,merMod-method} 5 | \alias{extract.merMod} 6 | \title{\code{\link{extract}} method for \code{merMod} objects} 7 | \usage{ 8 | \S4method{extract}{merMod}( 9 | model, 10 | method = c("naive", "profile", "boot", "Wald"), 11 | level = 0.95, 12 | nsim = 1000, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | include.dic = FALSE, 16 | include.deviance = FALSE, 17 | include.loglik = TRUE, 18 | include.nobs = TRUE, 19 | include.groups = TRUE, 20 | include.variance = TRUE, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{model}{A statistical model object.} 26 | 27 | \item{method}{The method used to compute confidence intervals or p-values. 28 | The default value \code{"naive"} computes naive p-values while the other 29 | methods compute confidence intervals using the \code{confint} function. See 30 | \code{\link[lme4]{confint.merMod}}.} 31 | 32 | \item{level}{Significance or confidence level (\code{1 - alpha}) for 33 | computing confidence intervals.} 34 | 35 | \item{nsim}{The MCMC sample size or number of bootstrapping replications on 36 | the basis of which confidence intervals are computed (only if the 37 | \code{method} argument does not specify \code{"naive"}, which is the 38 | default behavior). Note: large values may take considerable computing time.} 39 | 40 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 41 | block?} 42 | 43 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 44 | block?} 45 | 46 | \item{include.dic}{Report the deviance information criterion (DIC)?} 47 | 48 | \item{include.deviance}{Report the deviance?} 49 | 50 | \item{include.loglik}{Report the log likelihood in the GOF block?} 51 | 52 | \item{include.nobs}{Report the number of observations in the GOF block?} 53 | 54 | \item{include.groups}{Report the number of groups?} 55 | 56 | \item{include.variance}{Report group variances?} 57 | 58 | \item{...}{Arguments to be passed to the \code{\link[lme4]{fixef}} function 59 | in the \pkg{lme4} package.} 60 | } 61 | \description{ 62 | \code{\link{extract}} method for \code{merMod} objects created by the 63 | \pkg{lme4} package. 64 | } 65 | -------------------------------------------------------------------------------- /man/extract-lmerMod-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,lmerMod-method} 4 | \alias{extract,lmerMod-method} 5 | \alias{extract.lmerMod} 6 | \title{\code{\link{extract}} method for \code{lmerMod} objects} 7 | \usage{ 8 | \S4method{extract}{lmerMod}( 9 | model, 10 | method = c("naive", "profile", "boot", "Wald"), 11 | level = 0.95, 12 | nsim = 1000, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | include.dic = FALSE, 16 | include.deviance = FALSE, 17 | include.loglik = TRUE, 18 | include.nobs = TRUE, 19 | include.groups = TRUE, 20 | include.variance = TRUE, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{model}{A statistical model object.} 26 | 27 | \item{method}{The method used to compute confidence intervals or p-values. 28 | The default value \code{"naive"} computes naive p-values while the other 29 | methods compute confidence intervals using the \code{confint} function. See 30 | \code{\link[lme4]{confint.merMod}}.} 31 | 32 | \item{level}{Significance or confidence level (\code{1 - alpha}) for 33 | computing confidence intervals.} 34 | 35 | \item{nsim}{The MCMC sample size or number of bootstrapping replications on 36 | the basis of which confidence intervals are computed (only if the 37 | \code{method} argument does not specify \code{"naive"}, which is the 38 | default behavior). Note: large values may take considerable computing time.} 39 | 40 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 41 | block?} 42 | 43 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 44 | block?} 45 | 46 | \item{include.dic}{Report the deviance information criterion (DIC)?} 47 | 48 | \item{include.deviance}{Report the deviance?} 49 | 50 | \item{include.loglik}{Report the log likelihood in the GOF block?} 51 | 52 | \item{include.nobs}{Report the number of observations in the GOF block?} 53 | 54 | \item{include.groups}{Report the number of groups?} 55 | 56 | \item{include.variance}{Report group variances?} 57 | 58 | \item{...}{Arguments to be passed to the \code{\link[lme4]{fixef}} function 59 | in the \pkg{lme4} package.} 60 | } 61 | \description{ 62 | \code{\link{extract}} method for \code{lmerMod} objects created by the 63 | \code{\link[lme4]{lmer}} function in the \pkg{lme4} package. 64 | } 65 | -------------------------------------------------------------------------------- /man/extract-glmerMod-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,glmerMod-method} 4 | \alias{extract,glmerMod-method} 5 | \alias{extract.glmerMod} 6 | \title{\code{\link{extract}} method for \code{glmerMod} objects} 7 | \usage{ 8 | \S4method{extract}{glmerMod}( 9 | model, 10 | method = c("naive", "profile", "boot", "Wald"), 11 | level = 0.95, 12 | nsim = 1000, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | include.dic = FALSE, 16 | include.deviance = FALSE, 17 | include.loglik = TRUE, 18 | include.nobs = TRUE, 19 | include.groups = TRUE, 20 | include.variance = TRUE, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{model}{A statistical model object.} 26 | 27 | \item{method}{The method used to compute confidence intervals or p-values. 28 | The default value \code{"naive"} computes naive p-values while the other 29 | methods compute confidence intervals using the \code{confint} function. See 30 | \code{\link[lme4]{confint.merMod}}.} 31 | 32 | \item{level}{Significance or confidence level (\code{1 - alpha}) for 33 | computing confidence intervals.} 34 | 35 | \item{nsim}{The MCMC sample size or number of bootstrapping replications on 36 | the basis of which confidence intervals are computed (only if the 37 | \code{method} argument does not specify \code{"naive"}, which is the 38 | default behavior). Note: large values may take considerable computing time.} 39 | 40 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 41 | block?} 42 | 43 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 44 | block?} 45 | 46 | \item{include.dic}{Report the deviance information criterion (DIC)?} 47 | 48 | \item{include.deviance}{Report the deviance?} 49 | 50 | \item{include.loglik}{Report the log likelihood in the GOF block?} 51 | 52 | \item{include.nobs}{Report the number of observations in the GOF block?} 53 | 54 | \item{include.groups}{Report the number of groups?} 55 | 56 | \item{include.variance}{Report group variances?} 57 | 58 | \item{...}{Arguments to be passed to the \code{\link[lme4]{fixef}} function 59 | in the \pkg{lme4} package.} 60 | } 61 | \description{ 62 | \code{\link{extract}} method for \code{glmerMod} objects created by the 63 | \code{\link[lme4]{glmer}} function in the \pkg{lme4} package. 64 | } 65 | -------------------------------------------------------------------------------- /man/extract-nlmerMod-method.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract,nlmerMod-method} 4 | \alias{extract,nlmerMod-method} 5 | \alias{extract.nlmerMod} 6 | \title{\code{\link{extract}} method for \code{nlmerMod} objects} 7 | \usage{ 8 | \S4method{extract}{nlmerMod}( 9 | model, 10 | method = c("naive", "profile", "boot", "Wald"), 11 | level = 0.95, 12 | nsim = 1000, 13 | include.aic = TRUE, 14 | include.bic = TRUE, 15 | include.dic = FALSE, 16 | include.deviance = FALSE, 17 | include.loglik = TRUE, 18 | include.nobs = TRUE, 19 | include.groups = TRUE, 20 | include.variance = TRUE, 21 | ... 22 | ) 23 | } 24 | \arguments{ 25 | \item{model}{A statistical model object.} 26 | 27 | \item{method}{The method used to compute confidence intervals or p-values. 28 | The default value \code{"naive"} computes naive p-values while the other 29 | methods compute confidence intervals using the \code{confint} function. See 30 | \code{\link[lme4]{confint.merMod}}.} 31 | 32 | \item{level}{Significance or confidence level (\code{1 - alpha}) for 33 | computing confidence intervals.} 34 | 35 | \item{nsim}{The MCMC sample size or number of bootstrapping replications on 36 | the basis of which confidence intervals are computed (only if the 37 | \code{method} argument does not specify \code{"naive"}, which is the 38 | default behavior). Note: large values may take considerable computing time.} 39 | 40 | \item{include.aic}{Report Akaike's Information Criterion (AIC) in the GOF 41 | block?} 42 | 43 | \item{include.bic}{Report the Bayesian Information Criterion (BIC) in the GOF 44 | block?} 45 | 46 | \item{include.dic}{Report the deviance information criterion (DIC)?} 47 | 48 | \item{include.deviance}{Report the deviance?} 49 | 50 | \item{include.loglik}{Report the log likelihood in the GOF block?} 51 | 52 | \item{include.nobs}{Report the number of observations in the GOF block?} 53 | 54 | \item{include.groups}{Report the number of groups?} 55 | 56 | \item{include.variance}{Report group variances?} 57 | 58 | \item{...}{Arguments to be passed to the \code{\link[lme4]{fixef}} function 59 | in the \pkg{lme4} package.} 60 | } 61 | \description{ 62 | \code{\link{extract}} method for \code{nlmerMod} objects created by the 63 | \code{\link[lme4]{nlmer}} function in the \pkg{lme4} package. 64 | } 65 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: texreg 2 | Version: 1.39.5 3 | Date: 2025-12-21 4 | Title: Conversion of R Regression Output to LaTeX or HTML Tables 5 | Authors@R: c(person(given = "Philip", family = "Leifeld", email = "philip.leifeld@manchester.ac.uk", role = c("aut", "cre")), 6 | person(given = "Claudia", family = "Zucca", email = "c.zucca@jads.nl", role = "ctb")) 7 | Description: Converts coefficients, standard errors, significance stars, and goodness-of-fit statistics of statistical models into LaTeX tables or HTML tables/MS Word documents or to nicely formatted screen output for the R console for easy model comparison. A list of several models can be combined in a single table. The output is highly customizable. New model types can be easily implemented. Details can be found in Leifeld (2013), JStatSoft .) 8 | URL: https://github.com/leifeld/texreg/ 9 | BugReports: https://github.com/leifeld/texreg/issues/ 10 | Suggests: 11 | broom (>= 0.4.2), 12 | coda (>= 0.19.2), 13 | ggplot2 (>= 3.1.0), 14 | huxtable (>= 4.2.0), 15 | knitr (>= 1.22), 16 | nlme, 17 | rmarkdown (>= 1.12.3), 18 | sandwich (>= 2.3-1), 19 | systemfit (>= 1.1-0), 20 | testthat (>= 2.0.0), 21 | lmtest (>= 0.9-34) 22 | Depends: R (>= 3.5) 23 | Imports: methods, stats, httr 24 | Enhances: 25 | AER, 26 | alpaca, 27 | betareg, 28 | Bergm, 29 | bife, 30 | biglm, 31 | brglm, 32 | brms (>= 2.8.8), 33 | btergm (>= 1.10.10), 34 | dynlm, 35 | eha (>= 2.9.0), 36 | ergm (>= 4.1.2), 37 | feisr (>= 1.0.1), 38 | fGarch, 39 | fixest (>= 0.10.5), 40 | forecast, 41 | gamlss, 42 | gamlss.inf, 43 | gee, 44 | glmmTMB (>= 1.0.1), 45 | gmm, 46 | gnm, 47 | h2o, 48 | latentnet, 49 | lfe, 50 | lme4 (>= 1.1.34), 51 | logitr (>= 0.8.0), 52 | lqmm, 53 | maxLik (>= 1.4.8), 54 | metaSEM (>= 1.2.5.1), 55 | mfx, 56 | mhurdle, 57 | miceadds, 58 | mlogit, 59 | MuMIn, 60 | nnet, 61 | ordinal, 62 | pglm, 63 | plm (>= 2.4.1), 64 | prais (>= 1.1.3), 65 | relevent, 66 | remify (>= 3.2.6), 67 | remstats (>= 3.2.2), 68 | remstimate (>= 2.3.11), 69 | rms, 70 | robust, 71 | simex, 72 | spatialreg (>= 1.2.1), 73 | spdep (>= 1.2.2), 74 | speedglm, 75 | survival, 76 | truncreg (>= 0.2.5), 77 | VGAM 78 | SystemRequirements: pandoc (>= 1.12.3) suggested for using wordreg function; LaTeX packages tikz, booktabs, dcolumn, rotating, thumbpdf, longtable, paralist for the vignette 79 | License: GPL-3 80 | Encoding: UTF-8 81 | RoxygenNote: 7.3.2 82 | -------------------------------------------------------------------------------- /tests/testthat/test-praise.R: -------------------------------------------------------------------------------- 1 | context("praise function") 2 | suppressPackageStartupMessages(library("texreg")) 3 | 4 | test_that("praise gives useful error messages if the fields were not filled out properly", { 5 | expect_error(praise(organization = "test")) 6 | expect_error(praise(academic_user = TRUE)) 7 | expect_error(praise(academic_user = TRUE, organization = FALSE), "'organization' must be the name of your organization.") 8 | expect_error(praise(academic_user = 24), "'academic_user' must be TRUE if you are at a university or research institute and FALSE otherwise.") 9 | expect_error(praise(academic_user = TRUE, organization = "test", name = 25, general_praise = "test"), "Optional 'name' argument:") 10 | expect_error(praise(academic_user = TRUE, organization = "test"), 11 | "At least one of the arguments 'general_praise', 'increase_productivity', or 'increase_quality' must be provided") 12 | expect_error(praise(academic_user = TRUE, organization = "test", general_praise = NA), 13 | "'general_praise' is a free-form text argument where you can provide any kind of praise.") 14 | expect_error(praise(academic_user = TRUE, organization = "test", increase_productivity = NA), 15 | "'increase_productivity' argument: Tell us how texreg makes you more productive.") 16 | expect_error(praise(academic_user = TRUE, organization = "test", increase_quality = NA), 17 | "'increase_quality' argument: Tell us how texreg increases the quality of your work or reporting.") 18 | expect_error(praise(academic_user = TRUE, organization = "test", general_praise = "test", start_using = TRUE), 19 | "Optional 'start_using' argument: Tell us when you started using texreg") 20 | expect_error(praise(academic_user = TRUE, organization = "test", general_praise = "test", where_learn = 25), 21 | "Optional 'where_learn' argument: Tell us where or how you learned about texreg") 22 | expect_error(praise(academic_user = TRUE, organization = "test", general_praise = "test", contact_details = 25), 23 | "Optional 'contact_details' argument: How can we reach you if we need to ask for further testimony for our reporting purposes?") 24 | expect_error(praise(academic_user = TRUE, organization = "test", general_praise = "test", models = 25), 25 | "Optional 'models' argument: What kinds of statistical models do you use in your work most often?") 26 | expect_error(praise(academic_user = TRUE, organization = "test", general_praise = "test", num_users = TRUE), 27 | "Optional 'num_users' argument: How many other texreg users do you know approximately[?] Supply a number or some text.") 28 | }) 29 | -------------------------------------------------------------------------------- /man/extract.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/extract.R 3 | \name{extract} 4 | \alias{extract} 5 | \title{Extract details from statistical models for table construction} 6 | \usage{ 7 | extract(model, ...) 8 | } 9 | \arguments{ 10 | \item{model}{A statistical model object.} 11 | 12 | \item{...}{Custom parameters, which are handed over to subroutines. The 13 | arguments are usually passed to the \code{summary} function, but in some 14 | cases to other functions.} 15 | } 16 | \value{ 17 | The function returns a \linkS4class{texreg} object. 18 | } 19 | \description{ 20 | Extract details from statistical models for table construction. The function 21 | has methods for a range of statistical models. 22 | } 23 | \details{ 24 | The \code{\link{extract}} function serves to retrieve coefficients, standard 25 | errors, p-values, confidence intervals, and goodness-of-fit statistics from 26 | statistical models in \R. More than 100 \code{\link{extract}} methods 27 | ("extensions") for various statistical models are available. The function 28 | returns a \linkS4class{texreg} object. 29 | 30 | \code{\link{extract}} is a generic function, which extracts coefficients and 31 | GOF measures from statistical model objects. \code{\link{extract}} methods 32 | for the specific model types are called by the generic \code{\link{extract}} 33 | function if it encounters a model known to be handled by the specific method. 34 | The output is a \linkS4class{texreg} object, which is subsequently used by 35 | the \code{\link{texreg}} function and related functions. 36 | 37 | To list the model classes for which extract methods exist, type 38 | \code{showMethods("extract")} or \code{methods("extract")}. To show the 39 | method definition (i.e., the function body) of a specific extract method, use 40 | the \code{getMethod} function, for example \code{getMethod("extract", "lm")} 41 | for linear models. To get help on a specific extract method, type something 42 | like \code{?`extract,lm-method`} (or something similar for other models, 43 | where \code{"lm"} needs to be replaced by the class name of the respective 44 | model). You can also list the available methods by displaying the 45 | \link[=texreg-package]{texreg package} help index. 46 | 47 | Users can contribute their own extensions for additional statistical models. 48 | Examples are contained in the article in the Journal of Statistical Software 49 | referenced below. Suggestions can be submitted as pull requests at 50 | \url{https://github.com/leifeld/texreg/pulls} or through the issue tracker at 51 | \url{https://github.com/leifeld/texreg/issues}. 52 | } 53 | \references{ 54 | Leifeld, Philip (2013). texreg: Conversion of Statistical Model 55 | Output in R to LaTeX and HTML Tables. Journal of Statistical Software 56 | 55(8): 1-24. \doi{10.18637/jss.v055.i08}. 57 | } 58 | \seealso{ 59 | \code{\link{createTexreg}}, \code{\link{matrixreg}}, 60 | \code{\link{screenreg}}, \code{\link{texreg}} 61 | } 62 | \author{ 63 | Philip Leifeld 64 | } 65 | -------------------------------------------------------------------------------- /man/knitreg.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{knitreg} 4 | \alias{knitreg} 5 | \title{Flexibly choose the right table output format for use with \pkg{knitr}} 6 | \usage{ 7 | knitreg(...) 8 | } 9 | \arguments{ 10 | \item{...}{Arguments to be handed over to the \link{texreg}, \link{htmlreg}, 11 | \link{screenreg}, or \link{matrixreg} function. See the respective help 12 | page for details.} 13 | } 14 | \value{ 15 | A table as a \code{character} string in the respective output format. 16 | } 17 | \description{ 18 | Flexibly choose the right table output format for use with \pkg{knitr}. 19 | } 20 | \details{ 21 | This function automatically selects the right function (\link{texreg}, 22 | \link{screenreg}, \link{htmlreg}, or \link{matrixreg}) with the right set of 23 | arguments for use with the \pkg{knitr} package, for example in RStudio. The 24 | advantage of using this function with \pkg{knitr} is that the user does not 25 | need to replace the \link{texreg}, \link{htmlreg} etc. function call in the 26 | document when a different output format is selected. 27 | 28 | \link{knitreg} works with... 29 | \itemize{ 30 | \item \R HTML documents (\code{.Rhtml} extension) 31 | \item \R Sweave documents (\code{.Rnw} extension) for PDF output via LaTeX, 32 | rendered using... 33 | \itemize{ 34 | \item the \pkg{knitr} package 35 | \item the \pkg{Sweave} package 36 | } 37 | \item \R Markdown documents (\code{.Rmd} extension), rendered as... 38 | \itemize{ 39 | \item HTML documents 40 | \item PDF documents 41 | \item Word documents 42 | \item Powerpoint presentations 43 | \item Presentations (\code{.Rpres} extension, not \code{.Rmd}) 44 | } 45 | \item \R Notebooks, including preview 46 | } 47 | 48 | If Markdown and HTML rendering are selected, \link{htmlreg} arguments 49 | \code{doctype = FALSE} and \code{star.symbol = "*"} are set to enable 50 | compatibility with Markdown. With \R HTML documents (but not Markdown) or 51 | presentations (\code{.Rpres} extension), only \code{doctype = FALSE} is set. 52 | 53 | For PDF/LaTeX documents, the \link{texreg} argument 54 | \code{use.packages = FALSE} is set to suppress any package loading 55 | instructions in the preamble. The user must load any packages manually in the 56 | preamble of the document. 57 | 58 | The \pkg{knitr} and \pkg{rmarkdown} packages must be installed for this 59 | function to work. 60 | } 61 | \examples{ 62 | require("nlme") 63 | model.1 <- lme(distance ~ age, data = Orthodont, random = ~ 1) 64 | model.2 <- lme(distance ~ age + Sex, data = Orthodont, random = ~ 1) 65 | knitreg(list(model.1, model.2), center = FALSE, caption = "", table = FALSE) 66 | 67 | } 68 | \seealso{ 69 | \code{\link{texreg-package}} \code{\link{extract}} 70 | 71 | Other texreg: 72 | \code{\link{htmlreg}()}, 73 | \code{\link{huxtablereg}()}, 74 | \code{\link{matrixreg}()}, 75 | \code{\link{plotreg}()}, 76 | \code{\link{screenreg}()}, 77 | \code{\link{texreg}}, 78 | \code{\link{wordreg}()} 79 | } 80 | \author{ 81 | Philip Leifeld, with input from David Hugh-Jones 82 | } 83 | \concept{texreg} 84 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # texreg 2 | 3 | Conversion of R Regression Output to LaTeX or HTML Tables. 4 | 5 | Converts coefficients, standard errors, significance stars, and goodness-of-fit statistics of statistical models into LaTeX tables or HTML tables/MS Word documents or to nicely formatted screen output for the R console for easy model comparison. A list of several models can be combined in a single table. The output is highly customizable. New model types can be easily implemented. 6 | 7 | ## Documentation 8 | 9 | Details on **texreg** can be found in the following article: 10 | 11 | Leifeld, Philip (2013): **texreg**: Conversion of Statistical Model Output in R to LaTeX and HTML Tables. Journal of Statistical Software 55(8): 1-24. doi:[10.18637/jss.v055.i08](http://dx.doi.org/10.18637/jss.v055.i08) 12 | 13 | An updated version of this paper is included as a [package vignette](https://cran.r-project.org/web/packages/texreg/vignettes/texreg.pdf). Additional details on how to write custom extensions for **texreg** and manipulate **texreg** objects can be found in the following answers on StackOverflow: [[1]](http://stackoverflow.com/questions/38894044/print-beautiful-tables-for-h2o-models-in-r/39135080#39135080), [[2]](http://stackoverflow.com/questions/39397194/computing-p-values-in-spatial-econometric-models-why-are-there-inconsistencies/39479191#39479191), [[3]](http://stackoverflow.com/questions/36947477/how-can-i-use-texreg-1-36-4-for-a-relogit-model-estimated-using-zelig-v-5/36968738#36968738), [[4]](http://stackoverflow.com/questions/39143747/how-to-use-texreg-after-clmm-i-want-to-extract-random-effect-components/39507751#39507751), [[5]](http://stackoverflow.com/questions/40176607/r-how-to-get-a-proper-latex-regression-table-from-a-dataframe/40197961#40197961). 14 | 15 | ## Installation 16 | 17 | The last stable release can be installed from CRAN: 18 | ``` r 19 | install.packages("texreg") 20 | ``` 21 | To install the latest development version from GitHub, use the `remotes` package: 22 | ``` r 23 | remotes::install_github("leifeld/texreg") 24 | ``` 25 | 26 | ## Contribute to the project 27 | 28 | Please feel free to report bugs or suggested enhancements using the [issue tracker](http://github.com/leifeld/texreg/issues) and propose solutions for known bugs using a pull request. Please observe and follow the code formatting in the texreg package when doing so, and add (or update) `testthat` unit tests to your pull requests if possible. 29 | 30 | [![CRAN check and test](https://github.com/leifeld/texreg/actions/workflows/CRAN%20check%20and%20test.yaml/badge.svg)](https://github.com/leifeld/texreg/actions/workflows/CRAN%20check%20and%20test.yaml) 31 | [![cran version](https://www.r-pkg.org/badges/version/texreg)](https://cran.r-project.org/package=texreg) 32 | [![downloads](https://cranlogs.r-pkg.org/badges/texreg)](http://cranlogs.r-pkg.org/badges/texreg) 33 | [![total downloads](https://cranlogs.r-pkg.org/badges/grand-total/texreg)](http://cranlogs.r-pkg.org/badges/grand-total/texreg) 34 | [![Research software impact](http://depsy.org/api/package/cran/texreg/badge.svg)](http://depsy.org/package/r/texreg) 35 | [![Coverage status](https://codecov.io/gh/leifeld/texreg/branch/master/graph/badge.svg)](https://codecov.io/github/leifeld/texreg?branch=master) 36 | -------------------------------------------------------------------------------- /tests/testthat/test-plotreg.R: -------------------------------------------------------------------------------- 1 | context("plotreg") 2 | suppressPackageStartupMessages(library("texreg")) 3 | 4 | skip_if_not_installed("ggplot2") 5 | require("ggplot2") 6 | 7 | test_that("plotreg works", { 8 | skip_if_not_installed("ggplot2", minimum_version = "3.3.1") 9 | # linear model p-values 10 | ctl <- c(4.17, 5.58, 5.18, 6.11, 4.50, 4.61, 5.17, 4.53, 5.33, 5.14) 11 | trt <- c(4.81, 4.17, 4.41, 3.59, 5.87, 3.83, 6.03, 4.89, 4.32, 4.69) 12 | group <- gl(2, 10, 20, labels = c("Ctl", "Trt")) 13 | weight <- c(ctl, trt) 14 | m1 <- lm(weight ~ group) 15 | m2 <- lm(weight ~ group - 1) 16 | p1 <- plotreg(list(m1, m2)) 17 | p2 <- plotreg(list(m1, m2), ci.force = TRUE) 18 | p3 <- plotreg(list(m1, m2), custom.title = "My plot") 19 | p4 <- plotreg(list(m1, m2), custom.note = "My note") 20 | 21 | expect_true(ggplot2::is_ggplot(p1)) 22 | expect_true(ggplot2::is_ggplot(p2)) 23 | expect_true(ggplot2::is_ggplot(p3)) 24 | expect_true(ggplot2::is_ggplot(p4)) 25 | 26 | expect_s3_class(p1$data, "data.frame") 27 | expect_s3_class(p1, "gg") 28 | expect_equal(dim(p1$data), dim(readRDS("../files/PlotDataFrame.RDS"))) # test if data frame is correctly constructed 29 | #saveRDS(p1$data, "../files/PlotDataFrame.RDS") 30 | 31 | expect_identical(p1$labels$y, "Bars denote SEs (95%). Circle points denote significance.")# tests if it is printing the correct xlab 32 | expect_identical(p2$labels$y, "Bars denote CIs (95%) computed from SEs. Circle points denote significance.") # tests if it is printing the correct xlab 33 | expect_identical(p3$labels$title, "My plot") # test if title is printed 34 | expect_identical(p4$labels$y, "My note") # test if note is printed 35 | }) 36 | 37 | test_that("plotreg works with confidence intervals using the biglm package", { 38 | skip_if_not_installed("ggplot2", minimum_version = "3.3.1") 39 | skip_if_not_installed("biglm") 40 | skip_if_not_installed("broom") 41 | require("biglm") 42 | skip_if_not_installed("DBI") 43 | data("trees") 44 | ff <- log(Volume) ~ log(Girth) + log(Height) 45 | a <- biglm::bigglm(ff, data = trees, chunksize = 10, sandwich = TRUE) 46 | gg <- log(Volume) ~ log(Girth) + log(Height) + offset(2 * log(Girth) + log(Height)) 47 | b <- biglm::bigglm(gg, data = trees, chunksize = 10, sandwich = TRUE) 48 | p6 <- plotreg(list(a, b)) 49 | expect_true(ggplot2::is_ggplot(p6)) 50 | expect_equal(dim(p6$data), dim(readRDS("../files/PlotDataFrameCI.RDS"))) 51 | # saveRDS(p6$data, "../files/PlotDataFrameCI.RDS") 52 | expect_identical(p6$labels$y, "Bars denote SEs (95%). Circle points denote significance.") 53 | }) 54 | 55 | test_that("plotreg -odds ratio", { 56 | skip_if_not_installed("ggplot2", minimum_version = "3.3.1") 57 | # linear model p-values 58 | # the model is not actually suitable for odds ratio estimation, but it 59 | # makes no difference for testing plotreg 60 | ctl <- c(4.17, 5.58, 5.18, 6.11, 4.50, 4.61, 5.17, 4.53, 5.33, 5.14) 61 | trt <- c(4.81, 4.17, 4.41, 3.59, 5.87, 3.83, 6.03, 4.89, 4.32, 4.69) 62 | group <- gl(2, 10, 20, labels = c("Ctl", "Trt")) 63 | weight <- c(ctl, trt) 64 | m1 <- lm(weight ~ group) 65 | p7 <- plotreg(m1, override.coef = exp(m1$coefficients), ci.force = TRUE, ci.test = 1) 66 | 67 | expect_true(ggplot2::is_ggplot(p7)) 68 | expect_s3_class(p7$data, "data.frame") 69 | expect_s3_class(p7, "gg") 70 | expect_equal(dim(p7$data), dim(readRDS("../files/PlotDataFrameOR.RDS"))) # test if data frame is correctly constructed 71 | #saveRDS(p1$data, "../files/PlotDataFrameOR.RDS") 72 | class(p7$data$signif) 73 | # tests if significance is computed according to the value provided with ci.test 74 | expect_identical(as.character(p7$data$signif), as.character(c(TRUE, FALSE))) 75 | }) 76 | -------------------------------------------------------------------------------- /.github/workflows/CRAN check and test.yaml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | branches: [main, master] 4 | pull_request: 5 | branches: [main, master] 6 | workflow_dispatch: 7 | branches: [main, master] 8 | 9 | name: CRAN check and test 10 | 11 | jobs: 12 | CRAN-check-and-test: 13 | runs-on: ${{ matrix.config.os }} 14 | 15 | name: ${{ matrix.config.os }} (${{ matrix.config.r }}) 16 | 17 | strategy: 18 | fail-fast: false 19 | matrix: 20 | config: 21 | - {os: macOS-latest, r: 'release'} 22 | - {os: windows-latest, r: 'release'} 23 | - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} 24 | - {os: ubuntu-latest, r: 'release'} 25 | - {os: ubuntu-latest, r: 'oldrel-1'} 26 | 27 | env: 28 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 29 | R_KEEP_PKG_SOURCE: yes 30 | 31 | steps: 32 | - uses: actions/checkout@v2 33 | 34 | - uses: r-lib/actions/setup-tinytex@v2 35 | 36 | - uses: r-lib/actions/setup-r@v2 37 | with: 38 | r-version: ${{ matrix.config.r }} 39 | http-user-agent: ${{ matrix.config.http-user-agent }} 40 | use-public-rspm: true 41 | 42 | - name: add TeX deps 43 | run: | 44 | install.packages('tinytex') 45 | tinytex::tlmgr_install("ae") 46 | tinytex::tlmgr_install("thumbpdf") 47 | tinytex::tlmgr_install("paralist") 48 | tinytex::tlmgr_install("pgf") 49 | tinytex::tlmgr_install("grfext") 50 | shell: Rscript {0} 51 | 52 | - uses: r-lib/actions/setup-pandoc@v2 53 | 54 | - name: Query dependencies 55 | run: | 56 | install.packages(c("devtools", "covr")) 57 | saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2) 58 | writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version") 59 | shell: Rscript {0} 60 | 61 | - name: Cache R packages 62 | uses: actions/cache@v4 63 | with: 64 | path: ${{ env.R_LIBS_USER }} 65 | key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }} 66 | restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1- 67 | 68 | - name: Install system dependencies 69 | if: runner.os == 'Linux' 70 | run: | 71 | while read -r cmd 72 | do 73 | eval sudo $cmd 74 | done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "20.04"))') 75 | 76 | - name: Install dependencies 77 | run: | 78 | remotes::install_cran("rcmdcheck") 79 | devtools::install_deps(dependencies = c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances")) 80 | shell: Rscript {0} 81 | 82 | - name: Check 83 | env: 84 | _R_CHECK_CRAN_INCOMING_REMOTE_: false 85 | run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran", "--ignore-vignettes"), error_on = "error", check_dir = "check", build_args = c("--no-manual", "--no-build-vignettes", "--compact-vignettes=gs+qpdf")) 86 | shell: Rscript {0} 87 | 88 | - name: Upload check results 89 | if: failure() 90 | uses: actions/upload-artifact@main 91 | with: 92 | name: ${{ runner.os }}-r${{ matrix.config.r }}-results 93 | path: check 94 | 95 | - name: Unit testing 96 | run: withr::with_envvar(c("NOT_CRAN" = "true"), devtools::test()) 97 | shell: Rscript {0} 98 | 99 | - name: Test coverage 100 | run: withr::with_envvar(c("NOT_CRAN" = "true"), covr::codecov(quiet = FALSE)) 101 | shell: Rscript {0} 102 | -------------------------------------------------------------------------------- /man/createTexreg.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/texreg.R 3 | \name{createTexreg} 4 | \alias{createTexreg} 5 | \title{Constructor for \linkS4class{texreg} objects} 6 | \usage{ 7 | createTexreg( 8 | coef.names, 9 | coef, 10 | se = numeric(0), 11 | pvalues = numeric(0), 12 | ci.low = numeric(0), 13 | ci.up = numeric(0), 14 | gof.names = character(0), 15 | gof = numeric(0), 16 | gof.decimal = logical(0), 17 | model.name = character(0) 18 | ) 19 | } 20 | \arguments{ 21 | \item{coef.names}{The names for the covariates in a model as a 22 | \code{character} vector (= row names).} 23 | 24 | \item{coef}{The coefficients as a \code{numeric} vector. Can have length 25 | zero.} 26 | 27 | \item{se}{The standard errors as a \code{numeric} vector. Can have length 28 | zero.} 29 | 30 | \item{pvalues}{The p-values as a \code{numeric} vector. Can have length zero.} 31 | 32 | \item{ci.low}{The lower bounds of the confidence intervals as a 33 | \code{numeric} vector. Can have length zero.} 34 | 35 | \item{ci.up}{The upper bounds of the confidence intervals as a 36 | \code{numeric} vector. Can have length zero.} 37 | 38 | \item{gof.names}{Names of the goodness-of-fit statistics as a 39 | \code{character} vector. Can have length zero.} 40 | 41 | \item{gof}{Goodness-of-fit statistics as a \code{numeric} vector. Can have 42 | length zero.} 43 | 44 | \item{gof.decimal}{A \code{logical} vector with as many elements as the 45 | \code{gof} argument, indicating whether the respective GOF statistic is a 46 | double (\code{TRUE}) or integer (\code{FALSE}) number.} 47 | 48 | \item{model.name}{A name for the statistical model. Can be a \code{character} 49 | vector of length zero if there is no model name.} 50 | } 51 | \value{ 52 | A \linkS4class{texreg} object representing the statistical model. 53 | } 54 | \description{ 55 | Constructor for \linkS4class{texreg} objects. 56 | } 57 | \details{ 58 | This function creates a \linkS4class{texreg} object. A \linkS4class{texreg} 59 | object contains information about coefficients, standard errors, p-values 60 | (optional), and about goodness-of-fit statistics. Instead of standard 61 | errors and p-values, a \linkS4class{texreg} object may also contain upper and 62 | lower bounds of a confidence interval. \linkS4class{texreg} objects are used 63 | by the \code{\link{texreg}} function to create LaTeX tables and other 64 | representations of the model results. 65 | } 66 | \examples{ 67 | library("nlme") # load library for fitting linear mixed effects models 68 | model <- lme(distance ~ age, data = Orthodont, random = ~ 1) # estimate 69 | coefficient.names <- rownames(summary(model)$tTable) # extract coef names 70 | coefficients <- summary(model)$tTable[, 1] # extract coefficient values 71 | standard.errors <- summary(model)$tTable[, 2] # extract standard errors 72 | significance <- summary(model)$tTable[, 5] #extract p-values 73 | 74 | lik <- summary(model)$logLik # extract log likelihood 75 | aic <- summary(model)$AIC # extract AIC 76 | bic <- summary(model)$BIC # extract BIC 77 | n <- nobs(model) # extract number of observations 78 | gof <- c(aic, bic, lik, n) # create a vector of GOF statistics 79 | gof.names <- c("AIC", "BIC", "Log Likelihood", "Num. obs.") # names of GOFs 80 | decimal.places <- c(TRUE, TRUE, TRUE, FALSE) # last one is a count variable 81 | 82 | # create the texreg object 83 | tr <- createTexreg(coef.names = coefficient.names, 84 | coef = coefficients, 85 | se = standard.errors, 86 | pvalues = significance, 87 | gof.names = gof.names, 88 | gof = gof, 89 | gof.decimal = decimal.places) 90 | 91 | } 92 | \references{ 93 | Leifeld, Philip (2013). texreg: Conversion of Statistical Model 94 | Output in R to LaTeX and HTML Tables. Journal of Statistical Software 95 | 55(8): 1-24. \doi{10.18637/jss.v055.i08}. 96 | } 97 | \seealso{ 98 | \code{\link{extract}} 99 | } 100 | \author{ 101 | Philip Leifeld 102 | } 103 | -------------------------------------------------------------------------------- /tests/testthat/test-jss.R: -------------------------------------------------------------------------------- 1 | context("JSS article 2013") 2 | suppressPackageStartupMessages(library("texreg")) 3 | 4 | # example models from ?lm 5 | ctl <- c(4.17,5.58,5.18,6.11,4.50,4.61,5.17,4.53,5.33,5.14) 6 | trt <- c(4.81,4.17,4.41,3.59,5.87,3.83,6.03,4.89,4.32,4.69) 7 | group <- gl(2, 10, 20, labels = c("Ctl", "Trt")) 8 | weight <- c(ctl, trt) 9 | m1 <- lm(weight ~ group) 10 | m2 <- lm(weight ~ group - 1) 11 | 12 | test_that("texreg returns output as in the JSS 2013 article", { 13 | 14 | # Simple screenreg example 15 | expect_equal(output <- screenreg(list(m1, m2)), 16 | readRDS("../files/jss_screenreg_lm.RDS")) 17 | # saveRDS(output, "../files/jss_screenreg_lm.RDS") 18 | 19 | # texreg example with dcolumn and booktabs usage and table float options 20 | expect_equal(output <- texreg(list(m1, m2), 21 | dcolumn = TRUE, 22 | booktabs = TRUE, 23 | use.packages = FALSE, 24 | label = "tab:3", 25 | caption = "Two linear models.", 26 | float.pos = "bh"), 27 | readRDS("../files/jss_texreg_dcolumn_booktabs.RDS")) 28 | # saveRDS(output, "../files/jss_texreg_dcolumn_booktabs.RDS") 29 | 30 | # Bold coefficients, custom note, omit.coef, and coefficient customization 31 | # (difference to JSS: dollar signs around GOF values; but appearance otherwise identical) 32 | expect_equal(output <- texreg(list(m1, m2), 33 | label = "tab:4", 34 | caption = "Bolded coefficients, custom notes, three digits.", 35 | float.pos = "h", 36 | return.string = TRUE, 37 | bold = 0.05, 38 | stars = 0, 39 | custom.note = "Coefficients with $p < 0.05$ in \\textbf{bold}.", 40 | digits = 3, 41 | leading.zero = FALSE, 42 | omit.coef = "Inter"), 43 | readRDS("../files/jss_texreg_bold_customnote_digits.RDS")) 44 | # saveRDS(output, "../files/jss_texreg_bold_customnote_digits.RDS") 45 | 46 | # GLS example; custom names, reordering, single.row, 'extract' arguments 47 | # (difference to JSS: the paper reports results using 'no.margin = TRUE', but it's not in the code example) 48 | # (difference to JSS: the version used in the paper counts 11 places left of the right bracket; this is now correctly counted as 9) 49 | expect_equal({ 50 | library("nlme") 51 | m3 <- gls(follicles ~ sin(2 * pi * Time) + cos(2 * pi * Time), Ovary, 52 | correlation = corAR1(form = ~ 1 | Mare)) 53 | 54 | table <- texreg(list(m1, m3), 55 | custom.coef.names = c( 56 | "Intercept", 57 | "Control", 58 | "$\\sin(2 \\cdot \\pi \\cdot \\mbox{time})$", 59 | "$\\cos(2 \\cdot \\pi \\cdot \\mbox{time})$" 60 | ), 61 | custom.model.names = c("OLS model", "GLS model"), 62 | reorder.coef = c(1, 3, 4, 2), 63 | caption = "Multiple model types, custom names, and single row.", 64 | label = "tab:5", 65 | stars = c(0.01, 0.001), 66 | dcolumn = TRUE, 67 | booktabs = TRUE, 68 | use.packages = FALSE, 69 | no.margin = TRUE, 70 | single.row = TRUE, 71 | include.adjrs = FALSE, 72 | include.bic = FALSE) 73 | }, 74 | readRDS("../files/jss_texreg_gls.RDS") 75 | ) 76 | # saveRDS(table, "../files/jss_texreg_gls.RDS") 77 | 78 | # How to use "robust" standard errors with texreg 79 | skip_if_not_installed("sandwich") 80 | skip_if_not_installed("lmtest") 81 | expect_equal({ 82 | library("sandwich") 83 | library("lmtest") 84 | hc <- vcovHC(m2) 85 | ct <- coeftest(m2, vcov = hc) 86 | se <- ct[, 2] 87 | pval <- ct[, 4] 88 | output <- texreg(m2, override.se = se, override.pvalues = pval) 89 | }, 90 | readRDS("../files/jss_texreg_robust.RDS") 91 | ) 92 | # saveRDS(output, "../files/jss_texreg_robust.RDS") 93 | 94 | # Creating Word-readable HTML files using htmlreg 95 | expect_equal({ 96 | output <- htmlreg(list(m1, m2, m3), 97 | inline.css = FALSE, 98 | doctype = TRUE, 99 | html.tag = TRUE, 100 | head.tag = TRUE, 101 | body.tag = TRUE) 102 | }, 103 | readRDS("../files/jss_htmlreg_word.RDS") 104 | ) 105 | # saveRDS(output, "../files/jss_htmlreg_word.RDS") 106 | 107 | # Compatibility with Markdown 108 | expect_equal({ 109 | output <- htmlreg(list(m1, m2, m3), star.symbol = "\\*", center = TRUE) 110 | }, 111 | readRDS("../files/jss_htmlreg_markdown.RDS") 112 | ) 113 | # saveRDS(output, "../files/jss_htmlreg_markdown.RDS") 114 | 115 | # How to write a complete extension for linear models 116 | expect_equal({ 117 | extract.lm <- function(model, include.rsquared = TRUE, 118 | include.adjrs = TRUE, include.nobs = TRUE, ...) { 119 | 120 | s <- summary(model, ...) 121 | names <- rownames(s$coef) 122 | co <- s$coef[, 1] 123 | se <- s$coef[, 2] 124 | pval <- s$coef[, 4] 125 | 126 | gof <- numeric() 127 | gof.names <- character() 128 | gof.decimal <- logical() 129 | if (include.rsquared == TRUE) { 130 | rs <- s$r.squared 131 | gof <- c(gof, rs) 132 | gof.names <- c(gof.names, "R$^2$") 133 | gof.decimal <- c(gof.decimal, TRUE) 134 | } 135 | if (include.adjrs == TRUE) { 136 | adj <- s$adj.r.squared 137 | gof <- c(gof, adj) 138 | gof.names <- c(gof.names, "Adj.\\ R$^2$") 139 | gof.decimal <- c(gof.decimal, TRUE) 140 | } 141 | if (include.nobs == TRUE) { 142 | n <- nobs(model) 143 | gof <- c(gof, n) 144 | gof.names <- c(gof.names, "Num.\\ obs.") 145 | gof.decimal <- c(gof.decimal, FALSE) 146 | } 147 | 148 | tr <- createTexreg( 149 | coef.names = names, 150 | coef = co, 151 | se = se, 152 | pvalues = pval, 153 | gof.names = gof.names, 154 | gof = gof, 155 | gof.decimal = gof.decimal 156 | ) 157 | return(tr) 158 | } 159 | setMethod("extract", signature = className("lm", "stats"), definition = extract.lm) 160 | }, 161 | "extract" 162 | ) 163 | }) 164 | -------------------------------------------------------------------------------- /man/praise.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/praise.R 3 | \name{praise} 4 | \alias{praise} 5 | \alias{feedback} 6 | \alias{praise_interactive} 7 | \title{Publish praise about \pkg{texreg}} 8 | \usage{ 9 | praise( 10 | academic_user, 11 | organization, 12 | name = NULL, 13 | general_praise = NULL, 14 | increase_productivity = NULL, 15 | increase_quality = NULL, 16 | start_using = NULL, 17 | where_learn = NULL, 18 | contact_details = NULL, 19 | models = NULL, 20 | num_users = NULL, 21 | return.response = FALSE 22 | ) 23 | 24 | praise_interactive() 25 | } 26 | \arguments{ 27 | \item{academic_user}{Should be \code{TRUE} if you are at a university or 28 | public research institute. Should be \code{FALSE} if you are a private 29 | user, for example you are using \pkg{texreg} in your work for a firm, NGO, 30 | association, government department, as an individual user etc. We 31 | particularly need praise from non-academic users to demonstrate societal 32 | impact, but we can also make the case for academic usage to generate impact 33 | indirectly.} 34 | 35 | \item{organization}{Please tell us the name of the organization for which you 36 | are using \pkg{texreg}. If we can show that the package is being employed 37 | in a number of different settings, this will help us demonstrate impact.} 38 | 39 | \item{name}{(Optional) We would be delighted to to know who you are. After 40 | all, we can quote you much more effectively if we can tell the funders and 41 | employers who provided this praise! If possible, include your title.} 42 | 43 | \item{general_praise}{Use this argument to provide general praise, for 44 | example about the way it was designed, the user support you have received, 45 | or just how much you enjoy using it. While this is useful, however, we 46 | would be even more interested in receiving statements in how \pkg{texreg} 47 | makes you more productive (in the \code{increase_productivity} argument) or 48 | how it increases the quality of your work or your reports (through the 49 | \code{increase_quality} argument). Note: you need to provide at least one 50 | of these three free-form text arguments.} 51 | 52 | \item{increase_productivity}{This is one of the fields we are most interested 53 | in. Please use this field to tell us how \pkg{texreg} is making you more 54 | productive. For example, does it speed up writing your articles or research 55 | reports? Does it enable you to skip manual work like copy and paste of your 56 | results into your reports, or to avoid fiddling with table formatting? How 57 | much time has it saved you so far? Are there any other benefits in terms of 58 | productivity you can think of? Note: you need to provide feedback using at 59 | least one of the three free-form arguments (\code{general_praise}, 60 | \code{increase_productivity}, or \code{increase_quality}).} 61 | 62 | \item{increase_quality}{This is one of the fields we are most interested in. 63 | Please use this argument to tell us how \pkg{texreg} increases the quality 64 | of your work or the quality of your reporting. For example, does the 65 | package generate tables that look more professional than the tables you 66 | used to create manually? Are you using \link{screenreg} to improve your 67 | workflow by understanding better how the results of multiple models 68 | compare? Are you using \link{plotreg} to visualize and present your 69 | statistical results in a more effective way? Can you think of any other 70 | ways in which \pkg{texreg} is helping you? Note: you need to provide 71 | feedback using at least one of the three free-form arguments 72 | (\code{general_praise}, \code{increase_productivity}, or 73 | \code{increase_quality}).} 74 | 75 | \item{start_using}{(Optional) When did you start using \pkg{texreg}? We are 76 | interested in the approximate time or year as a free-form text argument, 77 | for example \code{"back in 2013 when the JSS article came out"}.} 78 | 79 | \item{where_learn}{(Optional) Where or how did you learn about the 80 | \pkg{texreg} package?} 81 | 82 | \item{contact_details}{(Optional) Tell us how we can contact you in case we 83 | would benefit from additional information. This might help us further down 84 | the road in compiling an impact case study or a similar report. Don't 85 | worry, this information will not be displayed on the website!} 86 | 87 | \item{models}{(Optional) Which kinds of statistical models do you use in your 88 | work? For example, \code{"Mostly linear models, but also lme4 and ergm."}.} 89 | 90 | \item{num_users}{(Optional) How many other \pkg{texreg} users do you know? In 91 | particular, if you are a non-academic user, would you mind telling us how 92 | many other non-academic users you are aware of and how many of them are in 93 | your organization? The more we know, the more convincing our evidence base 94 | will be. This argument accepts \code{numeric} values or more detailed 95 | responses as a \code{character} object.} 96 | 97 | \item{return.response}{If \code{TRUE}, a website with the submitted data will 98 | be returned as a \code{response} object, as defined in the \pkg{httr} 99 | package. You can load the \pkg{httr} package and use the 100 | \code{\link[httr]{content}} function, possibly enclosed in an 101 | \code{\link[base:character]{as.character}} call, to inspect the output and 102 | diagnose any problems with the transmission of the data. Only use this 103 | argument if instructed by the package authors.} 104 | } 105 | \value{ 106 | If everything works well, no output is returned (but see the 107 | \code{return.response} argument to change this). If the submission of the 108 | praise to the maintainer fails, a \code{response} object (as defined in the 109 | \pkg{httr} package) will be returned. Should you have any problems, do feel 110 | free to e-mail your praise to the package maintainer directly. 111 | } 112 | \description{ 113 | Publish praise about \pkg{texreg} to help the developers demonstrate impact. 114 | } 115 | \details{ 116 | The \code{\link{praise_interactive}} function asks you 11 questions 117 | interactively on the R console. You can choose to answer or skip them. Some 118 | questions are mandatory but most are optional. After collecting your answers, 119 | it will call the \code{\link{praise}} function to submit your praise. You can 120 | also choose to use the \code{\link{praise}} function directly and supply your 121 | answers as arguments. Either way is fine. 122 | 123 | Before your praise is submitted, the functions will present an interactive 124 | menu and ask if you want to submit the praise now. So do not worry about 125 | accidentally submitting feedback. 126 | 127 | You can use these functions to praise the \pkg{texreg} package. Funders and 128 | academic employers are increasingly interested in seeing evidence for the 129 | impact academic research generates. For software, such as \pkg{texreg}, this 130 | is very hard to accomplish because the developers are usually disconnected 131 | from the users. The consequence is that incentives for developing 132 | packages like these are diminishing the more the funders and employers 133 | require evidence of impact on society, firms, or policy makers. 134 | 135 | The \code{\link{praise}} and \code{\link{praise_interactive}} functions are 136 | our attempt at rectifying the situation. With these functions, you can 137 | provide positive feedback to the developers. The praise is saved to a 138 | database on the web server of the package maintainer and subsequently 139 | displayed at \url{https://www.philipleifeld.com/praise/} for other users, 140 | funders, and employers to view. This will also enable the package authors to 141 | compile reports about how \pkg{texreg} is used by academic and non-academic 142 | users to increase their productivity and work quality, for example in the 143 | form of an impact case study for the next round of the UK Research Excellence 144 | Framework (REF). 145 | 146 | We need many positive examples of how \pkg{texreg} has an impact on your 147 | work. We are especially interested in non-academic users, but welcome 148 | feedback from anyone. So please contribute by using the praise function! Tell 149 | us how cool this package is and how it has changed your work! 150 | 151 | The minimal information we require from you is whether you are an academic or 152 | non-academic user, the name of your organization, and some free-form praise 153 | (of a general nature, or about how it makes you more productive, or about how 154 | it increases the quality of your work or reporting). But there are some 155 | additional fields. While we are happy with the basic information, of course 156 | we will be happier if we also know your name, how to contact you, what kinds 157 | of models you work with, and some other details. Your choice! 158 | 159 | Please note that by using the \code{\link{praise}} or 160 | \code{\link{praise_interactive}} function you agree that the information you 161 | provide through the function, including your approximate location, is stored 162 | online in a database, displayed on the website of the package author, and 163 | used in reports to funders, employers etc. (This is the whole purpose of it.) 164 | You can contact the package maintainer any time to have your praise removed 165 | within a few days. 166 | } 167 | \examples{ 168 | \dontrun{ 169 | praise(academic_user = TRUE, 170 | organization = "University of Happy Tables", 171 | increase_quality = "Man, I've never seen such pretty tables!") 172 | } 173 | 174 | } 175 | \author{ 176 | Philip Leifeld 177 | } 178 | --------------------------------------------------------------------------------