Insert meta information in RMarkdown reports. Use this function within a code chunk and make sure to set the chunk option results = 'asis'.

report_Meta(x = .meta())

.meta(person = NA, date = NA, file_suffix = NA, file_path = NA)

Arguments

x

list (required): A named list with information on the following elements given in .meta. Consider using .meta as a constructor.

person

character (optional): Name of the person that conducted the experiment/measurement.

date

character (optional): Date of measurement.

file_suffix

character (optional): Do the raw measurement files have a common file suffix (pattern)?

file_path

character (optional): Path where the raw measurement files are stored on the ESR spectrometer.

Value

Text output via cat.

Examples

report_Meta(x = list("Max Mustermann", "Yesterday", c("_a", "_b"), "~/ESR/"))
#> **Person**: Max Mustermann #> #> **Date**: Yesterday #> #> **File suffix**: _a, _b #> #> **File path**: ~/ESR/ #>
report_Meta(.meta(person = "Max Mustermann", date = "Yesterday", file_suffix = c("_a", "_b"), file_path = "~/ESR/"))
#> **Person**: Max Mustermann #> #> **Date**: Yesterday #> #> **File suffix**: `_a`, `_b` #> #> **File path**: `~/ESR/` #>