sc_retrieve: Retrieve the data file declared by an indicator

In USGS-R/scipiper: Support functions for ushering data through a scientific workflow

Retrieve the data file declared by an indicator

Description

Identifies the data file's name by removing the indicator extension, then calls scmake to retrieve that file using a recipe given in the remake.yml

Usage

sc_retrieve(
  ind_file,
  remake_file = getOption("scipiper.getters_file"),
  ind_ext = getOption("scipiper.ind_ext"),
  verbose = FALSE
)

Arguments

ind_file	the file path of the indicator for which the corresponding data_file will be retrieved
remake_file	the file path+name of the remake file to use in retrieving the data file. On 10/10/20 the default value was changed from getOption('scipiper.remake_file') to getOption('scipiper.getters_file'). It is recommended to place all getters in a file named getters.yml or similar, which should not be imported by the main remake files.
ind_ext	the indicator file extension to expect at the end of ind_file, and for which any altered targets should have their build/status files updated

Value

the name of the retrieved data file

USGS-R/scipiper documentation built on May 25, 2023, 8:47 a.m.