ifcb_get_ecotaxa_example: Get EcoTaxa Column Names

View source: R/ifcb_get_ecotaxa_example.R

ifcb_get_ecotaxa_exampleR Documentation

Get EcoTaxa Column Names

Description

This function reads an example EcoTaxa metadata file included in the iRfcb package.

Usage

ifcb_get_ecotaxa_example(example = "ifcb")

Arguments

example

A character string specifying which example EcoTaxa metadata file to load. Options are:

"minimal"

Loads a minimal example, for fully manual entry.

"full_unknown"

Loads a full featured example, with unknown objects only.

"full_classified"

Loads a full featured example, with already classified objects.

"ifcb"

(Default) Loads a full IFCB-specific dataset used for EcoTaxa submissions.

Details

This function loads different types of EcoTaxa metadata examples based on the user's need. The examples include a minimal template for manual data entry, as well as fully featured datasets with or without classified objects. The default is an IFCB-specific example, originating from https://github.com/VirginieSonnet/IFCBdatabaseToEcotaxa. The example headers can used when submitting data from Imaging FlowCytobot (IFCB) instruments to EcoTaxa at https://ecotaxa.obs-vlfr.fr/.

Value

A data frame containing EcoTaxa example metadata.

Examples

ecotaxa_example <- ifcb_get_ecotaxa_example()

# Print the first five columns
dplyr::tibble(ecotaxa_example)

iRfcb documentation built on April 16, 2025, 1:09 a.m.