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

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)
#> # A tibble: 1 × 10
#>   rid   rname create_time access_time rpath rtype fpath last_modified_time etag 
#>   <chr> <chr> <chr>       <chr>       <chr> <chr> <chr>              <dbl> <chr>
#> 1 BFC1… file… 2023-07-17… 2023-07-17… /hom… rela… /tmp…                 NA NA   
#> # ℹ 1 more variable: expires <dbl>