demodelControl: Input parameters about output report

Description Usage Arguments Value Examples

View source: R/demodelControl.R

Description

Input parameters about output report

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
demodelControl(
  core = parallel::detectCores(),
  date = format(Sys.Date(), "%Y-%m-%d"),
  code.name = NULL,
  fig.height = 8,
  fig.width = 8,
  output.path = getwd(),
  table.file.name = NULL,
  fig.file.name = NULL
)

Arguments

core

A integer indicating how many cores will be used for parallel computation. The default uses all available cores.

date

The default is the the date when one run this code

code.name

the R file name used for demodelFit function. The default is 'demodel.R'. Can be modified for version control.

fig.height, fig.width

A integer. The height and width of figures attached in the final report. The default is 8 for both width and height. See ggsave for more information.

output.path

A string. Folder location where the report is saved

table.file.name

A string with suffix .xlsx. The file name of final report.

fig.file.name

deprecated. Will be deleted later.

Value

A named list

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 

demodelControl(core = 8,
               date = format(Sys.Date(), "%Y-%m-%d"),
               code.name = "demodel_core.R",
               output.path = getwd(),
               table.file.name = "preview.xlsx",
               fig.file.name = NULL)



## End(Not run)

CChen89/demodel documentation built on Dec. 17, 2021, 12:52 p.m.