cacheURL: Download and cache a file using BiocFileCache

Description Usage Arguments Value Note See Also Examples

View source: R/cacheURL.R

Description

Download and cache a file using BiocFileCache

Usage

1
2
3
4
5
6
7
cacheURL(
  url,
  pkg = "BiocFileCache",
  update = FALSE,
  ask = FALSE,
  verbose = TRUE
)

Arguments

url

character(1). Uniform Resource Locator (URL).

pkg

character(1). Package name.

update

logical(1). Call bfcneedsupdate internally to see if URL needs an update. Doesn't work reliably for all servers, so disabled by default.

ask

logical(1). Ask if package cache needs to be created or if file needs to be updated.

verbose

logical(1). Run the function with verbose output.

Value

character(1). Cached file path on disk.

Note

Updated 2021-05-18.

See Also

Examples

1
2
3
4
5
6
7
url <- pasteURL(
    pipetteTestsURL,
    "biocfilecache-test.txt",
    protocol = "none"
)
file <- cacheURL(url)
print(file)

acidgenomics/pipette documentation built on Sept. 27, 2021, 9:10 a.m.