reportSGP: Function for automatic technical report generation from SGP...

reportSGPR Documentation

Function for automatic technical report generation from SGP analyses.

Description

The function reportSGP is used to create automatic or customized technical reports associated with SGP analyses using the SGP object produced as part of the SGP analysis.

Usage

reportSGP(
  state,
	sgp_object,
	report_params,
	output_knit=TRUE)

Arguments

state

Acronym indicating state associated with the data. This can be supplied to the function automatically by including the full state name (e.g, New_Hampshire_SGP) in the name of the object supplied to sgp_object.

sgp_object

An SGP object resulting from SGP analyses.

report_params

list - parameters to use for the report. To be built out!

output_knit

Boolean – indicating whether to knit Rmd file. Default is TRUE.

Value

Returns a technical report in multiple output formats including HTML and PDF.

Author(s)

Adam Van Iwaarden avaniwaarden@nciea.org and Damian W. Betebenner dbetebenner@nciea.org

Examples

  ## Not run: 
    reportSGP()
  
## End(Not run)

CenterForAssessment/Literasee documentation built on July 2, 2023, 6:21 p.m.