setup_artifacts: Create ArtifSet instance

View source: R/extract_artifacts.R

setup_artifactsR Documentation

Create ArtifSet instance

Description

Create ArtifSet instance

Usage

setup_artifacts(
  type = "bioc",
  version = "3.17",
  date,
  hostnames = hostnames_by_release(version),
  cache = BiocFileCache::BiocFileCache(),
  destination = tempfile(),
  verbose = TRUE,
  extracted = NULL,
  url = NULL
)

Arguments

type

character(1) defaults to 'bioc' which implies 'software'; see Note.

version

character(1) defaults to "3.17"

date

character(1) "yyyy-mm-dd", not obligatory but can be used to retrieve earlier cache entry

hostnames

character() vector of host names for which build artifacts are available

cache

instance of 'BiocFileCache::BiocFileCache()'

destination

character(1) path to folder to use for artifacts

verbose

logical(1) if TRUE (default) will provide message about tar activity

extracted

defaults to NULL, if non-null a character(1) path to folder that holds 'report' folder

url

character(1) passed to 'get_report_tgz_cacheid'

Note

Use bbsBuildArtifacts:::valid_types() to see valid values for 'type'. The logic of managing artifacts from multiple dates is very cumbersome and may be unreliable, but the 'date of tarball production' will be reported for each ArtifSet.

Examples

if (interactive()) {
z = setup_artifacts(type="bioc", version="3.17")
z
}

vjcitn/bbsBuildArtifacts documentation built on Aug. 6, 2023, 2:06 p.m.