R/object-import.R

Defines functions format.rd_section_reexport merge.rd_section_reexport roxy_tag_rd.roxy_tag_.reexport rd_section_reexport

# Re-export ----------------------------------------------------------------
rd_section_reexport <- function(pkg, fun) {
  stopifnot(is.character(pkg), is.character(fun))
  stopifnot(length(pkg) == length(fun))

  rd_section("reexport", list(pkg = pkg, fun = fun))
}

#' @export
roxy_tag_rd.roxy_tag_.reexport <- function(x, base_path, env) {
  rd_section_reexport(x$val$pkg, x$val$fun)
}
#' @export
merge.rd_section_reexport <- function(x, y, ...) {
  stopifnot(identical(class(x), class(y)))
  rd_section_reexport(c(x$value$pkg, y$value$pkg), c(x$value$fun, y$value$fun))
}
#' @export
format.rd_section_reexport <- function(x, ...) {
  pkgs <- split(x$value$fun, x$value$pkg)
  pkg_links <- map2(names(pkgs), pkgs, function(pkg, funs) {
    funs <- sort_c(funs)
    files <- map_chr(
      funs,
      try_find_topic_in_package,
      pkg = pkg,
      where = " in re-export"
    )
    links <- paste0(
      "\\code{\\link[", pkg,
      ifelse(files == funs, "", paste0(":", files)),
      "]{", escape(funs), "}}",
      collapse = ", ")
    paste0("\\item{", pkg, "}{", links, "}")
  })

  paste0(
    "\\description{\n",
    "These objects are imported from other packages. Follow the links\n",
    "below to see their documentation.\n",
    "\n",
    "\\describe{\n",
    paste0("  ", unlist(pkg_links), collapse = "\n\n"),
    "\n}}\n"
  )
}

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.