R/generics.R

Defines functions notes cite

Documented in cite notes

#' Citation information for openESM datasets
#' @param x An object of class \code{openesm_dataset}.
#' @param ... Additional arguments passed to methods
#' @return Citation information for the dataset(s)
#' @examples
#' \donttest{
#' # Get citation for a dataset
#' dataset <- get_dataset("0001")
#' cite(dataset)
#' }
#' @export
cite <- function(x, ...) {
  UseMethod("cite")
}

#' Additional notes for openESM datasets
#' @param x An object of class \code{openesm_dataset}.
#' @param ... Additional arguments passed to methods
#' @return Additional notes and information about the dataset(s)
#' @examples
#' \donttest{
#' # Get notes for a dataset
#' dataset <- get_dataset("0001")
#' notes(dataset)
#' }
#' @export
notes <- function(x, ...) {
  UseMethod("notes")
}

Try the openesm package in your browser

Any scripts or data that you put into this service are public.

openesm documentation built on Dec. 3, 2025, 5:08 p.m.