R/BostonPhysics.R

In BigelowLab/fvcom: fvcom

#' A class for navigating  FVCOM datasets
#' 
#' @description R6 base class for Boston Innundation 
#' @export
Boston_Physics <-  R6::R6Class("Boston_Physics",
                                
  inherit = FVCOM_Physics,
  
  #' @param ... arguments for FVCOM_physics
  public = list(
    initialize = function(...){
      super$initialize(...)
    }
  )
)

#' Instantiate a FVCOM_Physics R6 object
#' 
#' @export
#' @param filename character either a filename or OpenDAP URL
#' @param ... other arguments passed to \code{FVCOM_Physics$new(filename, ...)}
#' @return FVCOM_Physics R6 Reference Object
BostonPhysics <- function(filename = file.path("http://www.smast.umassd.edu:8080",
                                              "thredds/dodsC/models/fvcom/NECOFS/Forecasts",
                                              "NECOFS_FVCOM_OCEAN_BOSTON_FORECAST.nc"),
                         ...){
  Boston_Physics$new(filename, ...)
}