Skip to contents

Import backported functions into your package

Source: R/import.R
import.Rd

Imports objects from backports into the namespace of other packages by assigning it during load-time. See examples for a code snippet to copy to your package.

Usage

import(pkgname, obj = NULL, force = FALSE)

Arguments

pkgname

[character(1)]
Name of the package where the backported function should be assigned.

obj

[character]
Name of objects to assign, as character vector. If NULL, all backports which are not provided by R itself are assigned.

force

[logical]
If obj is provided and force is set to FALSE, only backports not provided by the base package of the executing R interpreter are imported. Set to TRUE to ignore this check and always import the backport into the package's namespace.

See also

.onLoad

Examples

if (FALSE) { # \dontrun{
# This imports all functions implemented in backports while the package is loaded
.onLoad <- function(libname, pkgname) {
  backports::import(pkgname)
}

# This only imports the function "trimws"
.onLoad <- function(libname, pkgname) {
  backports::import(pkgname, "trimws")
}

# This imports all backports from base and force-imports "hasName" from utils
.onLoad <- function(libname, pkgname) {
  backports::import(pkgname)
  backports::import(pkgname, "hasName", force = TRUE)
}
} # }