get_report_tgz_cacheid: get reporting artifacts for a Bioconductor collection (e.g.,...

In vjcitn/bbsBuildArtifacts: analyze build artifacts for Bioconductor

get reporting artifacts for a Bioconductor collection (e.g., software, experiment, workflow, ...)

Description

get reporting artifacts for a Bioconductor collection (e.g., software, experiment, workflow, ...)

Usage

get_report_tgz_cacheid(
  version = "3.16",
  type = "bioc",
  cache = BiocFileCache::BiocFileCache(),
  url = NULL,
  date = Sys.Date()
)

Arguments

version	character(1) defaults to "3.16"
type	character(1) defaults to 'bioc' which implies 'software'; see Note.
cache	instance of 'BiocFileCache::BiocFileCache()'
url	defaults to NULL, if supplied, used to retrieve or cache tgz file
date	character(1) defaults to Sys.Date(), "yyyy-mm-dd" format, used to build informative name for caching/cache search

Value

A gzipped tarball is downloaded, informatively renamed, copied to a cache, and the cache reference is returned.

Note

Use bbsBuildArtifacts:::valid_types() to see valid values for 'type'. If url is NULL, the report.tgz content will be cached with name formed with type, version, and date of command invocation.

Examples

cururl = paste0("file://", system.file("test_report_3.14_bioc_20211210/test_report.tgz", 
    package="bbsBuildArtifacts"))
id = get_report_tgz_cacheid(url=cururl)
BiocFileCache::bfcquery(BiocFileCache::BiocFileCache(), cururl)

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