R/object-defaults.R

Defines functions package_suffix object_defaults.rcclass object_defaults.s4class object_defaults.import object_defaults.package object_defaults.data object_defaults.function object_defaults.default object_defaults

object_defaults <- function(x) UseMethod("object_defaults")

#' @export
object_defaults.default <- function(x) list()

#' @exportS3Method object_defaults "function"
object_defaults.function <- function(x) {
  list(
    roxy_tag("usage", NULL, object_usage(x)),
    # Used in process_inherit_params()
    roxy_tag(".formals", NULL, names(formals(x$value)))
  )
}

#' @export
object_defaults.s3generic <- object_defaults.function

#' @export
object_defaults.s3method <- object_defaults.function

#' @export
object_defaults.s4generic <- object_defaults.function

#' @export
object_defaults.s4method <- object_defaults.function

#' @export
object_defaults.data <- function(x) {
  str_out <- rd(object_format(x$value))

  list(
    roxy_tag("docType", NULL, "data"),
    roxy_tag("format", NULL, str_out),
    roxy_tag("keywords", NULL, "datasets"),
    roxy_tag("usage", NULL, object_usage(x))
  )
}

#' @export
object_defaults.package <- function(x) {
  desc <- x$value$desc

  description <- as.character(desc$Description)
  logo_path <- file.path(x$value$path, "man", "figures", "logo.png")
  if (file.exists(logo_path)) {
    fig <- "\\if{html}{\\figure{logo.png}{options: align='right' alt='logo' width='120'}}"
    description <- paste0(fig, "\n\n", description)
  }

  list(
    roxy_tag("docType", NULL, "package"),
    roxy_tag("name", NULL, package_suffix(desc$Package)),
    # "NULL" prevents addition of default aliases, see also #202
    roxy_tag("aliases", NULL, paste("NULL", desc$Package, package_suffix(desc$Package))),
    roxy_tag("title", NULL, paste0(desc$Package, ": ", desc$Title)),
    roxy_tag("description", NULL, description),
    roxy_tag("seealso", NULL, package_seealso(desc)),
    roxy_tag("author", NULL, package_authors(desc))
  )
}

#' @export
object_defaults.import <- function(x) {
  list(
    roxy_tag("docType", NULL, "import"),
    roxy_tag("name", NULL, "reexports"),
    roxy_tag("keywords", NULL, "internal"),
    roxy_tag("title", NULL, "Objects exported from other packages"),
    roxy_tag(".reexport", NULL, list(pkg = x$value$pkg, fun = x$value$fun))
  )
}

#' @export
object_defaults.s4class <- function(x) {
  list(
    roxy_tag("docType", NULL, "class")
  )
}

#' @export
object_defaults.rcclass <- function(x) {
  list(
    roxy_tag("docType", NULL, "class"),
    if (!is.null(x$methods))
      roxy_tag(".methods", NULL, x$methods)
  )
}

# Helpers -----------------------------------------------------------------

package_suffix <- function(name) {
  paste0(name, "-package")
}

Try the roxygen2 package in your browser

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

roxygen2 documentation built on Sept. 8, 2021, 9:08 a.m.