Skip to contents

Summarise biota data

Source: R/mod_CREED_fct_summarise.R
summarise_biota.Rd

Creates a summary string of biota including species, tissues, and life stages

Usage

summarise_biota(
  biotaData,
  SPECIES_GROUP = FALSE,
  SAMPLE_SPECIES = FALSE,
  SAMPLE_TISSUE = FALSE,
  SAMPLE_SPECIES_LIFESTAGE = FALSE,
  SAMPLE_SPECIES_GENDER = FALSE
)

Arguments

biotaData

The biota dataset. Use eDataDRF::example_biota_tibble() to generate an example input.

SPECIES_GROUP

Logical. Include species group summary? See eDataDRF::species_groups_vocabulary() for valid groups.

SAMPLE_SPECIES

Logical. Include sample species summary? See eDataDRF::species_names_vocabulary() for valid species.

SAMPLE_TISSUE

Logical. Include tissue type summary? See eDataDRF::tissue_types_vocabulary() for valid tissue types.

SAMPLE_SPECIES_LIFESTAGE

Logical. Include life stage summary? See eDataDRF::lifestage_vocabulary() for valid life stages.

SAMPLE_SPECIES_GENDER

Logical. Include gender summary? See eDataDRF::gender_vocabulary() for valid gender values.

Value

Character string summarising biota, or "Relevant data not found"

See also

eDataDRF::example_biota_tibble(), eDataDRF::species_groups_vocabulary(), eDataDRF::species_names_vocabulary(), eDataDRF::tissue_types_vocabulary(), eDataDRF::lifestage_vocabulary(), eDataDRF::gender_vocabulary()

Other summarise: calculate_coordinate_precision(), manual_completion_message(), summarise_CREED_details(), summarise_CREED_relevance(), summarise_CREED_reliability(), summarise_compartments(), summarise_date_range(), summarise_lod_loq(), summarise_measured_units(), summarise_multiple(), summarise_protocols(), summarise_reference(), summarise_sig_figs(), summarise_sites(), summarise_uncertainty_comments()

Examples

summarise_biota(eDataDRF::example_biota_tibble(), SAMPLE_SPECIES = TRUE, SAMPLE_TISSUE = TRUE)
#> [1] "1 biota samples. Species: Gadus morhua. Tissue types: Liver"