get_surface_height: get surface height from GLM simulation

View source: R/get_surface_height.R

get_surface_heightR Documentation

get surface height from GLM simulation

Description

Creates a data.frame with DateTime and surface_height.

Usage

get_surface_height(file = "output.nc", ice.rm = TRUE, snow.rm = TRUE, ...)

Arguments

file

a string with the path to the netcdf output from GLM

ice.rm

a boolean for including ice thickness in surface height

snow.rm

a boolean for including snow depth thickness in surface height

...

additional arguments passed to resample_sim

Value

a data.frame with DateTime and surface_height (in meters)

Author(s)

Jordan S. Read, Luke A. Winslow

Examples

sim_folder <- run_example_sim(verbose = FALSE)
nc_file <- file.path(sim_folder, 'output/output.nc')
surface <- get_surface_height(file = nc_file)
surface_w_ice <- get_surface_height(file = nc_file, ice.rm = FALSE, snow.rm = FALSE)

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