Skip to contents

Create collection labels

Source: R/collection_label.R
create_collection_label.Rd

Create collection labels (8 labels per DIN-A4 page)

Usage

create_collection_label(
  data = NULL,
  path = NULL,
  filename = NULL,
  qr = NULL,
  field1.column = NULL,
  field2.column = NULL,
  field3.column = NULL,
  field4.column = NULL,
  field5.column = NULL,
  logo = NULL,
  bgcolor = "D0ECC1",
  textcolor = "1E3F20",
  font = 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 "Collection_label".

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.

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 third free text to appear below field2.

field4.column

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

field5.column

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

Character (optional) Path to a PNG image to be located in the label bottom.

bgcolor

HTML color for label background. Default is D0ECC1

textcolor

HTML color for label text. Default is 1E3F20

font

Character. Font face to use. Default is Latin Modern. NOTE: not all fonts are supported, so unexpected results may occur. A list of fonts is available at https://tug.org/FontCatalogue/opentypefonts.html. See Details for more information.

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 named "Collection_label.pdf" is saved on disk, in the folder defined by path. If keep.files = TRUE, an RMarkdown and PNG logo files will also appear in the same folder.

Details

font Not all fonts can be used. Consider only those which are stated to be 'Part of TeX Live', and have OTF and TT available. Additionally, fonts whose 'Usage' differs from \normalfont, \itshape and \bfseries usually fail during installation and/or rendering.

Several fonts tried that seem to work are:

  • libertinus

  • accanthis

  • Alegreya

  • algolrevived

  • almendra

  • antpolt

  • Archivo

  • Baskervaldx

  • bitter

  • tgbonum

  • caladea

  • librecaslon

  • tgchorus

  • cyklop

  • forum

  • imfellEnglish

  • LobsterTwo

  • quattrocento

Author

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

Examples

if (FALSE) { # interactive()

create_collection_label(
  data = collection.table,
  path = "labeleR_output",
  qr = "QR_code",
  field1.column = "field1",
  field2.column = "field2",
  field3.column = "field3",
  field4.column = "field6",
  field5.column = "field7"
)
}