list_snirh_parameters: List available SNIRH parameters

Description

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)

Value

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

Arguments

sample_type: Character string specifying the sample type to filter by. Must be one of "water", "biota", "sediment", or "all". Default is "all".
include_conversion_info: Logical. If TRUE, includes conversion factors and unit information. Default is FALSE.

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

Examples

Run this code

# \donttest{
# List all water parameters
water_params <- list_snirh_parameters("water")
print(head(water_params))

# Get detailed conversion information
detailed_params <- list_snirh_parameters("water", include_conversion_info = TRUE)
print(head(detailed_params))

# 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 = ", ")))
# }