create.HyperSAS.report: Create a PDF report for the HyperSAS data collection for a...

In belasi01/HyperocR: Hyperspectral OCR data processing

Create a PDF report for the HyperSAS data collection for a station or a transit

Description

A PDF report is generated using knitr package facilities and a *.Rnw template. It provides an efficent mean to visualise the data. It can be called from the higher level function HyperSAS.go, or run in the command line as along as SAS.raw.RData and RRS.RData have been generated by process.HyperSAS.

Arguments

dirdat	is the current directory path contaning the files to process.
TYPE	is either equal to "STATION" or "TRANSIT" depending whether the folder gather replicate Rrs of the same station, or the data collected during the course of a ship transit. If the function is called from HyperSAS.go, the TYPE will be read in the file named directories.for.HyperSAS.dat. Otherwise the default is "STATION".
DIAGNOSTIC.PLOTS	is a logical parameter indicating whether or not diagnostic plots are saved in PNG format. It is used only when TYPE="TRANSIT". The plots shows the temporal variability in Ed and tilt, as well as the spectra for each Ed, Li and Lt recorded during the data acquisition. Default is FALSE.

Details

There is two templates located in the package data folder: "HyperSAS_Station_TEMPLATE.Rnw" and "HyperSAS_Transit_TEMPLATE.Rnw". This function will extract a number of informations from the current data directory and RData files. Next it uses the brew package to update the Rnw files. The Rnw files are converted into PDF using knitr package.

Author(s)

Simon Bélanger

See Also

process.HyperSAS, HyperSAS.go

belasi01/HyperocR documentation built on June 11, 2024, 7:21 a.m.