download_hcp_file: Download HCP file

Description Usage Arguments Value Examples

View source: R/download_hcp_file.R

Description

Downloads a file from HCP S3 Bucket

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
download_hcp_file(
  path_to_file,
  destfile = NULL,
  verbose = TRUE,
  error = TRUE,
  ...
)

download_fcp_file(...)

download_openneuro_file(...)

Arguments

path_to_file

Path to file on HCP S3 Bucket

destfile

Destination filename

verbose

should progress be added to downloading?

error

Should the function error if the return was bad?

...

arguments to pass to hcp_aws_url

Value

Output filename that was downloaded

Examples

1
2
3
4
if (have_aws_key()){
path_to_file <- "HCP_900/100206/MNINonLinear/100206.164k_fs_LR.wb.spec"
download_hcp_file(path_to_file = path_to_file)
}

muschellij2/hcp documentation built on Sept. 13, 2021, 4:21 p.m.