SILOReport: Write SILO data report to word document. The report includes...

View source: R/SILO.R

SILOReportR Documentation

Write SILO data report to word document. The report includes output from SILOSiteSummary(), SILOQualityCodes(), SILOMortonQualityCodes(). SILOMap(), SILOMonthlyRainfall(), SILOCumulativeDeviation() and SILODoubleMass().

Description

Write SILO data report to word document. The report includes output from SILOSiteSummary(), SILOQualityCodes(), SILOMortonQualityCodes(). SILOMap(), SILOMonthlyRainfall(), SILOCumulativeDeviation() and SILODoubleMass().

Usage

SILOReport(SILO, filename, path = getwd(), cols = pkg.env$cols)

Arguments

SILO

a list of sites with SILO data, as created by SILOLoad()

filename

filename to write the report to.

path

Optional. Folder to save the report to, defaults to current working directory

cols

Optional. vector of colours to use for the monthly rainfall and cumulative deviation plots. Must be at least as long as the number of sites in the SILO list.

Value

Nothing to the environment. A word document report is written to "filename".

Examples

## Not run: 
X<-SILOLoad(c("24001","24002","24003"),path="./SWTools/extdata")
SILOReport(X,"MyReport.docx") #requires pandoc installed

## End(Not run)


SWTools documentation built on May 31, 2023, 6:24 p.m.