ridl_resource_download: Download a RIDL resource

View source: R/ridlobject.R

ridl_resource_download.RIDLResourceR Documentation

Download a RIDL resource

Description

Download a RIDL resource into a specific folder

Usage

## S3 method for class 'RIDLResource'
ridl_resource_download(
  resource,
  folder = NULL,
  filename = NULL,
  quiet = FALSE,
  force = FALSE,
  ...
)

## S3 method for class 'RIDLResource'
rr_download(
  resource,
  folder = NULL,
  filename = NULL,
  quiet = FALSE,
  force = FALSE,
  ...
)

ridl_resource_download(resource, folder, filename, quiet, force, ...)

## Default S3 method:
ridl_resource_download(resource, folder, filename, quiet, force, ...)

rr_download(resource, folder, filename, quiet, force, ...)

## Default S3 method:
rr_download(resource, folder, filename, quiet, force, ...)

Arguments

resource

RIDLResource, a RIDL resource

folder

character, path of the directory where you will store the data

filename

character, name of the file you will download

quiet

logical, no progress bar from download (default = FALSE)

force

logical, force download (default = FALSE)

...

extra paramaters

Value

character, the download folder path

Examples

## Not run: 
#Setting the config to use RIDL default server
 res <- ridl_resource_show("98aa1742-b5d3-40c3-94c6-01e31ded6e84")
 ridl_resource_download(res, folder = "/tmp")

## End(Not run)

dickoa/ridl documentation built on April 23, 2023, 7:14 p.m.