Trawl a local CRAN archive to extract function names only from all packages

Trawl a local CRAN archive to extract function names only from all packages

Usage

pkgstats_fns_from_archive(
  path,
  archive = FALSE,
  prev_results = NULL,
  results_file = NULL,
  chunk_size = 1000L,
  num_cores = 1L,
  results_path = fs::path_temp()
)

Arguments

path

Path to local archive of R packages, either as source directories, or '.tar.gz' files such as in a CRAN mirror.

archive

If TRUE, extract statistics for all packages in the /Archive sub-directory, otherwise only statistics for main directory (that is, current packages only).

prev_results

Result of previous call to this function, if available. Submitting previous results will ensure that only newer packages not present in previous result will be analysed, with new results simply appended to previous results. This parameter can also specify a file to be read with readRDS().

results_file

Can be used to specify the name or full path of a .Rds file to which results should be saved once they have been generated. The '.Rds' extension will be automatically appended, and any other extensions will be ignored.

chunk_size

Divide large archive trawl into chunks of this size, and save intermediate results to local files. These intermediate files can be combined to generate a single prev_results file, to enable jobs to be stopped and re-started without having to recalculate all results. These files will be named pkgstats-results-N.Rds, where "N" incrementally numbers each file.

num_cores

Number of machine cores to use in parallel, defaulting to single-core processing.

results_path

Path to save intermediate files generated by the chunk_size parameter described above.

Value

A data.frame object with one row for each function in each package and the following columns:

• Package name

• Package version

• Function name

See also

Other archive: dl_pkgstats_data(), pkgstats_cran_current_from_full(), pkgstats_fns_update(), pkgstats_from_archive(), pkgstats_update()