NOTE: THIS REPOSITORY IS NOT INTENDED TO BE USABLE OR FULLY FUNCTIONAL. IT IS MEANT SOLELY AS AN EXPERIMENTAL REPOSITORY FOR TESTING DEVELOPMENT AND DEPLOYMENT OF R PACKAGES.
The goal of dsm2utils is to provide a variety of utilities for working with DSM2 tidefiles. This ranges from reading basic metadata (e.g., start and end datetimes) to extracting flows for a particular (external) channel number.
Installation
You can install the development version of dsm2utils from GitHub with:
# install.packages("devtools")
devtools::install_github("dougjack/dsm2utils")Example
This example shows how to obtain the basic metadata stored in a file, hist_v82.h5. Note: system.file() is used here to obtain the full path to an example tidefile. In your usage, you’ll just provide the path to the tidefile on your local machine.
library(dsm2utils)
out <- summarizeTidefile(system.file("extdata", "hist_v82.h5", package="dsm2utils", mustWork=TRUE))