generateReport: Generates report concerning converted data

View source: R/sunscan_functions.R

generateReportR Documentation

Generates report concerning converted data

Description

If one does not provide a report script, then the default report script is used.

Usage

generateReport(
  file,
  inputfolder,
  outputfolder,
  reportscript = system.file("reports", "default_report.R", package = "sunscanimport")
)

Arguments

file

filename

inputfolder

input folder

outputfolder

output folder

reportscript

script to generate the report

Details

A report script is an R script that may contain RMarkdown. Inside the script one can use the variable param with its elements param$file, param$inputfolder and param$outputfolder. The report will be placed in the outputfolder in the subdirectory report.

Notice that the package rmarkdown and knitr have to be installed to generate a report.


gk-crop/sunscanimport documentation built on Feb. 8, 2025, 3:15 p.m.