report_Sample: Insert a Sample Information Section

Description Usage Arguments Value Examples

View source: R/report_Sample.R

Description

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

Usage

1
2
3
4
report_Sample(x = .sample(), delim)

.sample(sample = NA, type = NA, exp_age = NA, n_aliquots = NA,
  measurement_dates = NA, irr_doses = NA)

Arguments

x

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

delim

character (required): Keyword specifying the delimiter insterted before the section. Usually "<br>" or "<hr>" for HTML and "\\newpage" for PDF reports.

sample

character: Sample name or laboratory code.

type

character: Sample type (e.g., "Coral" or "Mollusc").

exp_age

character: The expected age range.

n_aliquots

character: Number of aliquots used to determine the equivalent dose.

measurement_dates

character: When were the measurements conducted?

irr_doses

character: Irradiation doses (in Gy) of the individual aliquots.

Value

Text output via cat.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
report_Sample(x = list("K9999", "Coral", "Holocene", 20, "29/02/2016", 1:20),
              delim = "\\newpage")

report_Sample(.sample(sample = "K9999",
                      type = "Coral",
                      exp_age = "Holocene",
                      n_aliquots = 20,
                      measurement_dates = "29/02/2016",
                      irr_dose = 1:20),
               delim = "\\newpage")

tzerk/ESReport documentation built on Feb. 16, 2018, 12:23 p.m.