path_to_untarred_artifact_folders: untar the artifact archive and return the path

View source: R/get_report_tgz.R

path_to_untarred_artifact_foldersR Documentation

untar the artifact archive and return the path

Description

untar the artifact archive and return the path

Usage

path_to_untarred_artifact_folders(
  version = "3.16",
  type = "bioc",
  cache = BiocFileCache::BiocFileCache(),
  destination = tempdir(),
  verbose = TRUE,
  url = NULL,
  destbase = "/report"
)

Arguments

version

character(1) defaults to "3.16"

type

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

cache

instance of 'BiocFileCache::BiocFileCache()'

destination

character(1) path to folder to use, defaults to 'tempdir()'

verbose

logical(1) will indicate start and end of untar() process

url

passed to 'get_report_tgz_cacheid'

destbase

character(1) name of folder that includes all artifacts, defaults to "report"

Value

character(1) path to folder beneath which all artifacts are found

Note

Typically some additional files exist in addition to the package-related folders at the returned path. ':::non_package_pattern()' can be used to find these. Use bbsBuildArtifacts:::valid_types() to see valid values for 'type'.

Examples

cururl = demo_url()
td = tempdir()
path_to_untarred_artifact_folders(url=cururl, destination=td, destbase="test_report")

vjcitn/bbsBuildArtifacts documentation built on Sept. 20, 2024, 5:30 a.m.