Abstract Class for Local Package Resources

Local source code is distinct from other local sources because it carries the assumption that all files needed to fully reproduce the original package are bundled alongside.

Usage

local_source_resource(
  package = NA_character_,
  version = NA_character_,
  id = next_id(),
  md5 = NA_character_,
  path = NA_character_
)

Arguments

package

character(1L) Package name. Optional, but should be provided if possible.

version

character(1L) Package version, provided as a string.

id

integer(1L) optional id used for tracking resources throughout execution. Generally not provided directly, as new objects automatically get a unique identifier. For example, the package source code from a repo_resource() may be downloaded to add a source_archive_resource() and add it to a new multi_resource(). Because all of these represent the same package, they retain the same id. Primarily the id is used for isolating temporary files.

md5

character(1L) md5 digest of the package source code tarball. This is not generally provided directly, but is instead derived when acquiring resources.

path

character(1L) file system path to the local package resource.

Details

Unlike package archives that might be distributed or local installs, source code contains all tests and files which may be ignored as part of the build process, yet may be informative for metric assessment.

See also

Other resources: cran_repo_resource(), git_resource(), install_resource(), local_resource(), mock_resource(), multi_resource(), remote_resource(), repo_resource(), resource(), source_archive_resource(), source_code_resource(), unknown_resource()