CreateChecklist: CreateChecklist: Create a custom checklist for Rveg

View source: R/CreateChecklist.R

CreateChecklistR Documentation

CreateChecklist: Create a custom checklist for Rveg

Description

Generates a custom species checklist formatted for use within the Rveg package. This function takes a list of full botanical names and deterministically converts them into unique, 7-character ShortName codes.

Rveg includes the following built-in checklists:

  • cz_dh2012 (Default: Checklist of vascular plants of the Czech Republic)

  • Czechia_slovakia_2015 (Turboveg compatible checklist)

  • cz_kaplan2019 (Rveg generated - Kaplan et al. 2019)

  • wcvp_que (example WCVP subset for Quebec)

  • wcvp_por (example WCVP subset for Portugal)

Usage

CreateChecklist(specieslist, export = "export")

Arguments

specieslist

Character vector OR Character. Either a vector of full botanical names in your R environment, or a path to a .txt file containing a single column named "FullName".

export

Character. The output path and name for the exported checklist. Defaults to a temporary directory.

Details

ShortName Generation Rules: The function guarantees a unique 7-character code for every species. The first 4 characters always represent a unique Genus code. The remaining 3 characters depend on the taxonomic rank:

  • Standard Species: Genus (4) + first 3 letters of the specific epithet (e.g., GENUEPI).

  • Species (sp.): Genus (4) + -SP (e.g., GENU-SP).

  • Hybrids (x): Genus (4) + * + first 2 letters of hybrid epithet (e.g., GENU*HY).

  • Aggregates (agg.): Genus (4) + ⁠#⁠ + first 2 letters of main epithet (e.g., GENU#EP).

  • Subspecies (ssp.): Genus (4) + first letter of main epithet + - + first letter of infra epithet (e.g., GENUE-I).

  • Varieties/Forms (var./f.): Genus (4) + first letter of main epithet + ⁠;⁠ + first letter of infra epithet (e.g., ⁠GENUE;I⁠).

  • Sections (sect.): Genus (4) + SE + first letter of section epithet (e.g., GENUSEE).

Note: If a 7-character code clash occurs, the 7th character is automatically adjusted using trailing letters or alphanumeric fallbacks to ensure absolute uniqueness.

Value

Writes a .txt file containing two columns (ShortName and FullName) to the location specified by export. The output can be then used inside addReleve and other functions.

Examples

  # Example 1: Creating a checklist from a local txt file
  CreateChecklist(
    specieslist = paste0(path.package("Rveg"), "/extdata/SpeciesList"),
  )


Rveg documentation built on March 1, 2026, 5:06 p.m.