Skip to contents

Get information about the current package

Source: R/utils.R
pkg_info.Rd

Returns information about the current package in a list which can be passed to other functions.

Usage

pkg_info(pkg_path = ".", ...)

Arguments

pkg_path

Path to the package directory. Default is "." for the current working directory, which assumes developer is working in R package root. However, this can be set to another path as needed.

...

Arguments passed to rprojroot::find_package_root_file.

Value

A list of information about the package.

  • pkgroot: Root directory of the package.

  • pkgdeps: Package dependencies from Imports in the DESCRIPTION.

  • descfile: File path to the DESCRIPTION file.

  • pkgname: Package name.

  • pkgver: Package version.

Examples

if (FALSE) {
# Specify path to example package source and copy to tempdir()
# Note that in practice you do not need to copy to a tempdir()
# And in fact it may be easiest to use pracpac relative to your package directory root
ex_pkg_src <- system.file("hellow", package = "pracpac", mustWork = TRUE)
file.copy(from = ex_pkg_src, to = tempdir(), recursive = TRUE)

# This will succeed if this is a package
pkg_info(pkg_path = file.path(tempdir(), "hellow"))
# This will fail if this is not a package location
pkg_info(pkg_path = tempdir())
}