compare_to_field: compare metric for GLM vs field observations

In USGS-R/glmtools: Tools for working with the General Lake Model (GLM)

compare metric for GLM vs field observations

Description

compare metric for GLM vs field observations, but must have more than 3 matching time points. This function is only designed to handle calls to physical metrics that return a single value. An example of this behavior is thermocline depth (but not water density for all depth-resolved measurements).

Usage

compare_to_field(
  nc_file,
  field_file,
  nml_file,
  metric,
  as_value = FALSE,
  na.rm = TRUE,
  ...
)

Arguments

nc_file	a string with the path to the netcdf output from GLM
field_file	a string with the path to the field observation file
nml_file	a string with the path to the nml file (optional)
metric	a string representing a physical metric. Should be a rLakeAnalyzer function or other valid function.
as_value	a boolean for calculating RMSE (F) or returning all values (T)
na.rm	a boolean for remove NAs (only used if as_values == F)
...	additional arguments passed to resample_to_field()

Value

a RMSE (in native units) for the comparison, or DateTime and all values as a data.frame (if as_values == T)

Author(s)

Jordan S. Read

See Also

resample_sim, resample_to_field

Examples

nc_file <- system.file("extdata", "output/output.nc", package = "glmtools")
field_file <- system.file("extdata", "LakeMendota_field_data_hours.csv", package = "glmtools")

thermo_values <- compare_to_field(nc_file, field_file,
                                  metric = 'thermo.depth', as_value = TRUE,)

temp_rmse <- compare_to_field(nc_file, field_file,
                              metric = 'water.temperature', as_value = FALSE)
print(paste(round(temp_rmse,3),'deg C RMSE'))
# function in development
buoy_file <- system.file("extdata", "LakeMendota_buoy_data.csv", package = "glmtools")
temp_rmse <- compare_to_field(nc_file, buoy_file,
                              metric = 'water.temperature', as_value = FALSE,
                              method = 'interp',precision = 'hours')
print(paste(round(temp_rmse,3),'deg C RMSE'))
## Not run: 
# -- an nml file is necessary when functions require hypsographic information
# -- will fail
values <- compare_to_field(nc_file, field_file,
                             metric = 'schmidt.stability', as_value = TRUE)
# -- will succeed
nml_file <- file.path(sim_folder, 'glm3.nml')
values <- compare_to_field(nc_file, field_file, nml_file,
                             metric = 'schmidt.stability', as_value = TRUE)
  
# -- metrics can only be calculated by functions that are available to this environment
# -- will fail
values <- compare_to_field(nc_file, field_file, metric = 'calc.fols', as_value = TRUE)

## End(Not run)

USGS-R/glmtools documentation built on March 26, 2024, 5:43 p.m.