data_use: Load a dataset registered to your project

In ki-tools/kitools: Tools for Analysis Workflows in Knowledge Integration

Description

Load a dataset registered to your project

Usage

data_use(name, check_update = TRUE, read_fn = NULL)

Arguments

name	name of the dataset registered with your project (matches the base name of the data file according to its path in project_config.yml)
check_update	should Synapse be checked to see if there is an updated file available? (default TRUE)
read_fn	an optional function providing code to read in the data file (if not a supported "rds" or "csv" file or if custom reading options are desired). This function should take as a single parameter the path to the file, which will be supplied when it is called.

Details

If the dataset has not been pulled from Synapse, you will first need to register it with your project using data_pull using its Synapse ID. If it has been previously pulled, a check against Synapse will be made for a newer version and the user will be prompted about whether to update the data.

ki-tools/kitools documentation built on Feb. 17, 2020, 7:10 p.m.