cipres_list_files: List and download files associated with a job

Description Usage Arguments Details Value Examples

Description

Find and download the files associated with a job.

Usage

1
2
3
4
cipres_list_files(job_handle, ...)

cipres_download(job_handle, outdir, pattern = NULL, ignore.case = FALSE,
  show_progress = TRUE, ...)

Arguments

job_handle

the job identified

...

arguments to customize the API call. These arguments are passed to the appropriate httr function (GET, POST, DELETE)

outdir

the path where the files should be downloaded

pattern

an optional regular expression to download only the files that match the pattern

ignore.case

should pattern matching be case sensitive?

show_progress

should the progress of the files being downloaded be displayed?

Details

Be careful, files with identical names will be silently overwritten.

By only providing a job handle to cipres_download, all the files generated by the job will be downloaded. To download only one or a subset of these files, you can use regular expression pattern matching.

Value

cipres_list_files returns a data frame listing all the files associated with a job. cipres_download_file and cipres_download_all returns whether the files were successfully downloaded.

Examples

1
2
3
4
5
6
7
8
## Not run: 
### List the files associated with the oldest job
### cipres_list_files(cipres_list_jobs$handle[1])

### Download all the files associated with the oldest job
### cipres_download(cipres_list_jobs$handle[1], tempdir())

## End(Not run)

fmichonneau/cipresr documentation built on May 16, 2019, 1:44 p.m.