Function reference • ereefs

All functions
`assignList()`	Utility function copied directly from the package 'tis' by Jeff Hallman (https://github.com/cran/tis/blob/master/R/assignList.R) Assigns the values in a list to variables in an environment. The variable names are taken from the names of the list, so all of the elements of the list must have non-blank names.
`check_platform_ok()`	Check whether the platform is Windows and the filename contains "http": if so, return a warning Now always returns TRUE as the CRAN version of ncdf4 for Windows can now handle THREDDS services
`daysIn()`	Calculate the number of days in the month of the specified date
`download_discharge()`	Download river discharge (flow) data from Qld. Govt. servers at https://water-monitoring.information.qld.gov.au
`earth.dist()` `earth.dist()`	Calculate rough distance in kilometers between two points
`ereefs-package` `ereefs`	The 'ereefs' package.
`find_intersections()`	An internal utility function to find the grid line intersections of a line segment
`get_chron_date()`	A simple function to convert a date provided in any of several formats to a chron date
`get_ereefs_bottom_ts()`	Extracts time-series of selected variables from the bottom water-column cell at specified locations from eReefs output files
`get_ereefs_case()`	Determines whether the file provided looks like a THREDDS catalog, or an example of daily (e.g. GBR1), monthly (e.g. GBR4) or other (e.g. RECOM) netcdf file output
`get_ereefs_depth_integrated_ts()`	Extracts depth-integrated time-series of selected variables at specified locations from eReefs output files
`get_ereefs_depth_specified_ts()`	Extracts time-series of selected variables from eReefs output files at a specified location and depth below the surface.
`get_ereefs_grids()`	Returns an appropriate x_grid, y_grid and z_grid
`get_ereefs_profile()`	Extract vertical profiles of specified variables from a specified latitude and longitude over a specified time-period from an eReefs or other EMS netcdf file.
`get_ereefs_slice()`	Extract a vertical slice or depth-resolved transect from an eReefs or other EMS netcdf output file.
`get_ereefs_ts()`	Extracts time series at specified locations from eReefs model output files
`get_file_stem()`	Returns the 'stem' of a filename (i.e. the filename with the date and extension cut off the end)
`get_origin_and_times()`	Opens the netcdf file, input_file, and extracts the origin (reference date/time) and time dimension.
`get_params()`	Set up various parameters needed by many of the data extraction and plotting functions
`map_ereefs()`	Create a surface map of eReefs model output.
`map_ereefs_movie()`	Create a series of map image files for an animation of eReefs model output AND calculate temporal mean values.
`plot_ereefs_profile()`	Plots a single vertical profile using output from get_ereefs_profile()
`plot_ereefs_slice()`	Produces a coloured tile plot of a vertical slice already fetched from an eReefs or other EMS netcdf file.
`plot_ereefs_zvt()`	Produces a coloured rect plot of a vertical profile over time
`plot_map()`	Create a map using a dataframe in the format required by ggplot2::geom_plot, for instance from map_ereefs() or map_ereefs_movie()
`plume_class()`	Calculate and return the plume optical class from eReefs model output..
`poly2sp()`	Convert a polygon dataframe in the format used by ggplot2::geom_polygon to a spatialPolygonDataFrame
`safe_nc_open()`	A wrapper to ncdf4::nc_open() that will pause and try again up to 119 times if at first it fails, to overcome temporary net access errors or DAP errors.
`safe_ncvar_get()`	A wrapper to ncdf4::ncvar_get() that will pause and try again several times (defaulting to 12) if it is a web-served netcdf file and at first it fails, to overcome temporary net access errors or DAP errors.
`sp2raster()`	Convert a SpatialPolygonDataFrame to a raster. (Wrapper for raster::rasterize() with some reasonable defaults for the ereefs package)
`substitute_filename()`	Check whether the given filename is a shortcut and if so, set the full filename

Reference

All functions