write_labels: Writting Labels for Herbarium Vouchers

View source: R/write_labels.R

write_labelsR Documentation

Writting Labels for Herbarium Vouchers

Description

Generating labels for vouchers using exported tables.

Usage

write_labels(x, ...)

## S3 method for class 'specimens'
write_labels(
  x,
  output_file,
  merge = TRUE,
  frame = FALSE,
  date_format = "%d.%m.%Y",
  dim = c(h = 74, w = 105, u = "mm"),
  nup = c(2, 4),
  mar = c(l = 7, r = 7, t = 7, b = 7, u = "mm"),
  classoption = "a4paper",
  ...
)

Arguments

x

A specimens object retrieved by read_specimens().

...

Further arguments passed to list2rmd_doc(). It works only if 'merge = TRUE'.

output_file

A character value indicating the name of the file. It may include a relative path. This is passed to the homonymous parameter at render_rmd().

merge

A logical value indicating whether labels should be merged into one A4 sheet or remain as individual pages in the output PDF file.

frame

A logical value indicating whether a frame should be drawn around single labels or not. It works only if 'merge = TRUE'.

date_format

A character value indicating the format used for the collection date. It is passed to the function format.Date().

dim

A named vector indicating the dimensions of the single labels. You need to specify w (width), h (height), and u (units).

nup

An integer vector of length 2 indicating the number of labels per sheet (if 'merge = TRUE'). The first value are number of columns and the second, number of rows.

mar

A named vector indicating the margins. The mandatory names are l (left), r (right), t (top), b (bottom), and u (units).

classoption

A character value to be inserted as 'classoption' in the yaml head for the Rmarkdown document.

Value

An invisible rmd_doc object.


kamapu/specimensDB documentation built on March 15, 2024, 1:27 p.m.