ClinReport (version 0.9.1.14)

report.modelinfo: Export model information (still experimental)

Description

report.doc This function enables to export the information of the model (the package, the name of the function, the call etc...)

Usage

report.modelinfo(object, ...)
# S3 method for lme
report.modelinfo(object, doc = NULL, page.break = TRUE,
  ...)
# S3 method for lmerMod
report.modelinfo(object, doc = NULL,
  page.break = TRUE, ...)
# S3 method for glm
report.modelinfo(object, doc = NULL, page.break = TRUE,
  ...)
# S3 method for coxph
report.modelinfo(object, doc = NULL, page.break = TRUE,
  ...)

Arguments

object

A model (for now glm, lme, lmer and coxph models are availlable)

...

Other arguments

doc

NULL or a rdocx object

page.break

Logical. If TRUE it adds a page break after the output. Default to TRUE

Value

A flextable object (if doc=NULL) or a rdocx object (if doc= an rdocx object).

Details

Compatible only (for now) with GLM, LME and Cox models. For now those output are not numbered.

See Also

report.doc

Examples

# NOT RUN {
library(officer)
library(flextable)
library(nlme)
library(lme4)

data(datafake)

#Model info for lme model

mod=lme(y_numeric~GROUP+TIMEPOINT,random=~1|SUBJID,data=datafake,na.action=na.omit)

# Show in HTML (can be inserted in an R markdown or a MS Word document)

report.modelinfo(mod)

#Model info for lmer model

mod=lmer(y_numeric~GROUP+TIMEPOINT+(1|SUBJID),data=datafake,na.action=na.omit)

report.modelinfo(mod)

# }