Skip to contents

Create herbarium labels

Source: R/herbarium.R
create_herbarium_label.Rd

Create herbarium labels (4 labels per DIN-A4 page)

Usage

create_herbarium_label(
  data = data,
  path = NULL,
  filename = NULL,
  title = NULL,
  subtitle = NULL,
  qr = NULL,
  family.column = NULL,
  taxon.column = NULL,
  author.column = NULL,
  det.column = NULL,
  date.det.column = NULL,
  location.column = NULL,
  area.description.column = NULL,
  latitude.column = NULL,
  longitude.column = NULL,
  elevation.column = NULL,
  field1.column = NULL,
  field2.column = NULL,
  field3.column = NULL,
  collector.column = NULL,
  collection.column = NULL,
  assistants.column = NULL,
  date.column = NULL,
  keep.files = FALSE,
  template = NULL
)

Arguments

data

a data frame. Each row contains the information by species that will appear in the label.

path

Character. Path to folder where the PDF file will be saved.

filename

Character. Filename of the pdf. If NULL, default is "Herbarium".

title

Main title at the top of the labels. Can be blank if set to NULL.

subtitle

Subtitle at the bottom of the labels. Can be blank if set to NULL.

qr

String. Free text or column of data that specifies the link for the QR code. If the specified value of qr is not a column name of data, all the QRs will be equal, pointing to the same link.

family.column

Character (optional). Name of the column in data storing the family of the taxon.

taxon.column

Character (optional). Name of the column in data storing the taxon name.

author.column

Character (optional). Name of the column in data storing the taxon author.

det.column

Character (optional). Name of the column in data storing the determiner of the voucher.

date.det.column

Character (optional). Name of the column in data storing the date when the voucher was determined.

location.column

Character (optional). Name of the column in data storing where the voucher was collected.

area.description.column

Character (optional). Name of the column in data storing the description of the area.

latitude.column

Character (optional). Name of the column in data storing the latitude where the specimen was collected.

longitude.column

Character (optional). Name of the column in data storing the longitude where the specimen was collected.

elevation.column

Character (optional). Name of the column in data storing the elevation where the specimen was collected.

field1.column

Character (optional). Name of the column in data storing the first free text to appear at the top of the label.

field2.column

Character (optional). Name of the column in data storing the second free text to appear below field1.

field3.column

Character (optional). Name of the column in data storing the second free text to appear below field2.

collector.column

Character (optional). Name of the column in data storing the name of the collector.

collection.column

Character (optional). Name of the column in data storing the voucher's collection number.

assistants.column

Character (optional). Name of the column in data storing the names of the collector's assistants.

date.column

Character (optional). Name of the column in data storing the date when the specimen was collected.

keep.files

Logical. Keep the RMarkdown template and associated files in the output folder? Default is FALSE.

template

Character (optional) RMarkdown template to use. If not provided, using the default template included in labeleR.

Value

A pdf file with four herbarium labels per page within an 'output' folder.

Author

Ignacio Ramos-Gutierrez, Julia G. de Aledo, Francisco Rodriguez-Sanchez

Examples

if (FALSE) { # interactive()

create_herbarium_label (
  data = herbarium.table,
  path = "labeleR_output",
  title = "Magical flora of the British Isles",
  subtitle = "Project: Eliminating plant blindness in Hogwarts students",
  qr = "QR_code",
  family.column ="Family",
  taxon.column = "Taxon",
  author.column = "Author",
  det.column = "det",
  date.det.column = "Det_date",
  location.column = "Location",
  latitude.column = "Latitude",
  longitude.column = "Longitude",
  elevation.column = "Elevation",
  field1.column = "life_form",
  field3.column = "Height",
  collector.column = "Collector",
  collection.column = "Collection_number",
  assistants.column = "Assistants",
  date.column = "Date"
)
}