create.report: Create a PDF report for a vertical profile performed using an...

View source: R/create.report.R

create.reportR Documentation

Create a PDF report for a vertical profile performed using an optical package

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 IOPs.go, or run in the command line as along as IOPs.RData and IOPs.fitted.down.RData have been generated by correct.merge.IOP.profile.

Usage

create.report(dirdat)

Arguments

dirdat

is the current directory path contaning the RData file to plot.

Details

The program edit a template named IOP_Station_TEMPLATE.Rnw located in the package data folder. It will extract a number of informations from the current data directory and RData files, cast.info.dat and instruments.dat files. For example, the Latitude/Longitude are extracted from the cast.info.dat file to create a map (Figure 1 of the report). Next it uses the brew package to update the Rnw files.

The Rnw files are converted into PDF using knitr package. Both files will be saved in dirdat and a "figures" folder is created with a PDF file for each figures found in the report.

Author(s)

Simon Belanger

See Also

correct.merge.IOP.profile, IOPs.go


belasi01/Riops documentation built on Sept. 5, 2022, 6:38 p.m.