description_sheet: Export a description sheet in PDF format.

In kamapu/specimensDB: Linking databases with package specimens

Export a description sheet in PDF format.

Description

Automatic rendering of an overview sheet for a specific bulk.

Usage

description_sheet(db, ...)

## S3 method for class 'PostgreSQLConnection'
description_sheet(
  db,
  schema = "specimens",
  bulk,
  wd = tempdir(),
  output_file,
  output = "pdf_document",
  ...,
  date_format = "%d.%m.%Y",
  p_tiles = "OpenStreetMap",
  zoomLevelFixed = 5,
  vwidth = 1200,
  vheight = 500,
  render_args = list()
)

Arguments

db	Connection to the database as PostgreSQLConnection.
...	Further arguments passed to list2rmd_doc().
schema	A character value with the names of the schema containing the table of the projects (mandatory name of this table is projects).
bulk	Integer vector including the ID's of the requested bulks (campaigns or projects).
wd	A character value indicating the path to store produced files (i.e. Figures and r-markdown files.
output_file	A character value indicating the name of the rendered PDF file.
output	A character value or a list included in the yaml header.
date_format	A character value indicating the format of displayed collection dates.
p_tiles	A character vector indicating the name of provider tiles used as background map. It is passed to addProviderTiles().
zoomLevelFixed	An integer value passed to addMiniMap().
vwidth, vheight	An integer value each, passed to mapshot().
render_args	A named list with arguments passed to render_rmd().

Value

A PDF file will be written.

Author(s)

Miguel Alvarez [e-mail]

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