inst/example_packages/exampleGood/R/s3_example.R

In checked: Systematically Run R CMD Checks

#' An example of an S3 generic
#'
#' @param x An X
#' @param ... Ellipsis
#'
#' Used to ensure traces can be linked through s3 dispatch
#'
#' @rdname s3_example_func
#' @export
s3_example_func <- function(x, ...) {
  UseMethod("s3_example_func")
}

#' @rdname s3_example_func
#' @export
s3_example_func.default <- function(x, ...) {
  "default"
}

#' @rdname s3_example_func
#' @export
s3_example_func.list <- function(x, ...) {
  "list"
}