Skip to contents

List available SNIRH parameters

Source: R/list_snirh_parameters.R
list_snirh_parameters.Rd

Returns a summary of available parameters in the conversion table, organized by sample type. This helps users understand what parameters can be converted to SNIRH format.

Usage

list_snirh_parameters(sample_type = "all", include_conversion_info = FALSE)

Arguments

sample_type

Character string specifying the sample type to filter by. Must be one of "water", "biota" or "all". Default is "all".

include_conversion_info

Logical. If TRUE, includes conversion factors and unit information. Default is FALSE.

Value

A data.table with parameter information. Columns depend on include_conversion_info parameter.

Details

This function provides an overview of the parameter conversion capabilities of the package. It can help users:

  • Understand what parameters are supported

  • Check parameter naming conventions

  • Verify unit conversion factors

  • Plan data preparation activities

See also

parameters for the complete parameter dataset

Examples

# \donttest{
# List all water parameters
water_params <- list_snirh_parameters("water")
print(head(water_params))
#>    sample_type                                     param_lab
#>         <char>                                        <char>
#> 1:       water              % DE BIOVOLUME DE CIANOBACTÉRIAS
#> 2:       water                                  (m+p)-Xileno
#> 3:       water                            (meta+para)-Xileno
#> 4:       water                              1,2-Dicloroetano
#> 5:       water              1,2-Dicloroetano - Subcontratado
#> 6:       water 2,4,5-T (Ácido (2,4,5-triclorofenoxi)acético)
#>                             param_snirh  symbol_snirh
#>                                  <char>        <char>
#> 1: % DE BIOVOLUME DE CIANOBACTÉRIAS (%) %_BIOV_CIANOB
#> 2:                  (m+p)-Xileno (ug/l)     mp_XILENO
#> 3:                  (m+p)-Xileno (ug/l)     mp_XILENO
#> 4:       1,2-Dicloroetano ou EDC (ug/l)      _12CLETA
#> 5:       1,2-Dicloroetano ou EDC (ug/l)      _12CLETA
#> 6:                       2,4,5-T (ug/l)        _245T_

# Get detailed conversion information
detailed_params <- list_snirh_parameters("water", include_conversion_info = TRUE)
print(head(detailed_params))
#>    sample_type                                     param_lab unit_lab
#>         <char>                                        <char>   <char>
#> 1:       water              % DE BIOVOLUME DE CIANOBACTÉRIAS        %
#> 2:       water                                  (m+p)-Xileno     µg/L
#> 3:       water                            (meta+para)-Xileno     µg/L
#> 4:       water                              1,2-Dicloroetano     µg/L
#> 5:       water              1,2-Dicloroetano - Subcontratado     µg/L
#> 6:       water 2,4,5-T (Ácido (2,4,5-triclorofenoxi)acético)     ng/L
#>                             param_snirh unit_snirh  symbol_snirh factor
#>                                  <char>     <char>        <char>  <num>
#> 1: % DE BIOVOLUME DE CIANOBACTÉRIAS (%)        (%) %_BIOV_CIANOB  1.000
#> 2:                  (m+p)-Xileno (ug/l)       µg/l     mp_XILENO  1.000
#> 3:                  (m+p)-Xileno (ug/l)       µg/l     mp_XILENO  1.000
#> 4:       1,2-Dicloroetano ou EDC (ug/l)       µg/l      _12CLETA  1.000
#> 5:       1,2-Dicloroetano ou EDC (ug/l)       µg/l      _12CLETA  1.000
#> 6:                       2,4,5-T (ug/l)       µg/l        _245T_  0.001

# Check all available sample types
all_params <- list_snirh_parameters("all")
unique_types <- unique(all_params$sample_type)
print(paste("Available sample types:", paste(unique_types, collapse = ", ")))
#> [1] "Available sample types: biota, sediment, water"
# }