make_model_report: Generate report(s) with modeling stats using pandoc.

Description Usage Arguments Value

View source: R/reports.R

Description

Generate report(s) with modeling stats using pandoc.

Usage

1
2
3
4
make_model_report(modelfit, data, K = 5, format = c("html", "pdf", "word"),
  file.name = getOption("gridisl.file.name"),
  file.path = getOption("gridisl.file.path"), openFile = TRUE,
  keep_md = FALSE, keep_tex = FALSE, ...)

Arguments

modelfit

Model fit object returned by model fitting functions.

data

Input dataset used for model fitting (optional).

K

The number of top performing models for which to provide performance measures. Defaults to 5 or the total number of models fit, whichever is smaller.

format

Choose the Pandoc output format for the report file (html, pdf or word). Note that the html report file is always produced in addition to any other selected format.

file.name

File name for the report file without extension. Default file name is assigned based on the current date.

file.path

Directory path where the report file(s) should be written. Default is to use the system temporary directory.

openFile

Open the report file with OS default viewer?

keep_md

Keep the source .md files?

keep_tex

Keep the source .tex files for pdf output?

...

Additional arguments may specify the report title (author), author (title). Specifying the logical flag only.coefs=TRUE disables printing of all h2o-specific model summaries.

Value

String specifying the path to the main report file.


osofr/gridisl documentation built on May 24, 2019, 4:55 p.m.