getReport: Report Generation

In leppott/CASTfxn: Functions for Causal Assessment Screening Tool (CAST)

Description

Generate report

Usage

getReport(TargetSiteID, dir_results = file.path(getwd(), "Results"),
  report_type = "summary", report_format = "html",
  dir_rmd = file.path(system.file(package = "CASTfxn"), "rmd"))

Arguments

TargetSiteID	SiteID
dir_results	Directory with subfolders named by SiteID. Default = Results folder in working directory.
report_type	Requested report type (all or summary). Default = summary
report_format	Requested report output format (html or word). Default = HTML
dir_rmd	Directory with template RMD for report. Default = package rmd folder.

Details

Generates a report based on a Target SiteID in a given directory. The output from other 'CASTfxn' functions are stored in a "Results" folder with the provided Target SiteID as a subdirectory. Report format can be "html" (recommended default) or "word" (docx).

Only the "summary" report is active.

Value

A report for the provided SiteID in the provided format (html or word) in the results directory.

Examples

TargetSiteID <- "SRCKN001.61"
dir_results <- file.path(getwd(), "Results")
report_type <- "summary"
report_format <- "html"
 
## Not run: 
# Run Function
getReport(TargetSiteID, dir_results, report_type, report_format)

## End(Not run)

leppott/CASTfxn documentation built on Sept. 6, 2019, 11:04 p.m.