Skip to contents

Create Information on Local Package Installation

Source: R/set_up_pkg.R
set_up_pkg.Rd

This function unpacks a package tarball using unpack_tarball() and returns information about whether the unpacked directory exists. It is a lightweight preparatory step used before attempting a local package installation.

Usage

set_up_pkg(dp)

Arguments

dp

Character string. Path to a package tarball or package directory.

Value

A named list with the following elements:

  • package_installed — Logical. TRUE if the unpacked package directory exists, otherwise FALSE.

  • pkg_source_path — Character string giving the unpacked package source directory, or "" if unpacking failed.

The returned object is always a base R list. It contains no side effects besides calling unpack_tarball() and checking filesystem paths.

Output Meaning

A value of package_installed = TRUE indicates that the unpacked directory exists on disk and can be used for local installation.

package_installed = FALSE indicates either:

  • unpack_tarball() returned an empty result, or

  • the unpacked directory does not exist on disk.

Examples

if (FALSE) { # \dontrun{
set_up_pkg(path/to/package, "mypackage")
} # }