Generate a pdf, Word or HTML report on any data set in the jfsp package.
datadoc(data, file, title = "", subtitle = "", metadata = FALSE, open_doc = TRUE, keep_rmd = FALSE, details = TRUE)
| data | jfsp data set, e.g., |
|---|---|
| file | character, output file, must end in .pdf, .docx, or .html. See details. |
| title | character, document title. |
| subtitle | character, document subtitle. Set to |
| metadata | logical, if |
| open_doc | logical, open document after rendering. Defaults to |
| keep_rmd | logical, retain the intermediary Rmd document. Defaults to |
| details | logical, if set to |
nothing is returned, but a file is written to disk.
Create a report for a specific data set. The report summarizes the variables in the data set. It is a wrapper around and based on dataMaid::makeDataReport, though it renders output with some differences not available in dataMaid.
Pandoc must be available on the system for rendering to pdf. It is recommended to run from RStudio, which includes the necessary components, if you have difficulty. For Word documents (docx) it is necessary to be on a Windows system with Microsoft Word installed. If no file name is supplied, the output defaults to HTML and the file name is the name of the data set.
If metadata = TRUE, information about the system environment and conditions at run time when the document was generated is included at the bottom of the document. If FALSE (default), they are removed.
Because datadoc does not directly render the document with dataMaid and makes some internal changes to the Rmd file, the function call line in the metadata is always removed due to its resulting lack of clarity.
# NOT RUN { datadoc(fmoba) # }