report: Generate CRDS data report

View source: R/report.R

reportR Documentation

Generate CRDS data report

Description

Combines data associated with a job and writes job report in specified format.

Usage

report(job, firstDate = "2010-01-01", style = "sirfer", runs = FALSE,
  ignore = TRUE, plot = TRUE)

Arguments

job

character. Job number or other value used to group samples in the ID2 field, e.g., “21-014”.

firstDate

character. Earliest run date to include in the report, e.g., “2010-01-01”.

style

character. Report format, one of “sirfer”, “neon”, or “spatial”.

runs

logical. Return a list of runs for the specified job and firstDate instead of generating reports?

ignore

logical. Remove sample and standard values that did not meet QC criteria?

plot

logical. Generate GMWL plot with all sample values?

Details

Requires access to a user configuration file written using write_config and properly formatted and structured data files and directories. See package man page CRDSutils for details.

Writes output to the “reportPath” directory documented in the user's configuration file.


SPATIAL-Lab/CRDSutils documentation built on Dec. 12, 2024, 3:23 a.m.