Skip to contents

Summarise sites data

Source: R/mod_CREED_fct_summarise.R
summarise_sites.Rd

Creates a summary string of sites including countries and areas

Usage

summarise_sites(
  sitesData,
  COUNTRY_ISO = FALSE,
  OCEAN_IHO = FALSE,
  SITE_GEOGRAPHIC_FEATURE = FALSE,
  SITE_GEOGRAPHIC_FEATURE_SUB = FALSE,
  PRECISION = FALSE
)

Arguments

sitesData

The sites dataset. Use eDataDRF::example_sites_tibble() to generate an example input.

COUNTRY_ISO

Logical. Include country summary? See eDataDRF::countries_vocabulary() for valid country codes.

OCEAN_IHO

Logical. Include area summary? See eDataDRF::ocean_vocabulary() for valid ocean areas.

SITE_GEOGRAPHIC_FEATURE

Logical. Include geographic feature summary? See eDataDRF::geographic_features_vocabulary() for valid features.

SITE_GEOGRAPHIC_FEATURE_SUB

Logical. Include geographic feature sub summary? See eDataDRF::geographic_features_sub_vocabulary() for valid sub-features.

PRECISION

Logical. Include coordinate precision?

Value

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

See also

eDataDRF::example_sites_tibble(), eDataDRF::countries_vocabulary(), eDataDRF::ocean_vocabulary(), eDataDRF::geographic_features_vocabulary(), eDataDRF::geographic_features_sub_vocabulary()

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

Examples

summarise_sites(eDataDRF::example_sites_tibble(), COUNTRY_ISO = TRUE, PRECISION = TRUE)
#> [1] "2 sites. Countries: Norway. Lowest coordinate precision: 4"