archs4_local_data_dir_create: Initialize a local datadir to act as an ARCHS4 data datadir
In denalitherapeutics/archs4: Wrappers to query and extract ARCHS4 data

Description Usage Arguments Details Value

Initialize a local datadir to act as an ARCHS4 data datadir

1 2	archs4_local_data_dir_create(datadir = getOption("archs4.datadir"), stop_if_exists = TRUE)

`datadir`	the path to the datadir to create (or initialize) as an ARCHS4 data datadir.
`stop_if_exists`	by default, this function will `stop` if `datadir` already exists. Set this to `FALSE` to continue. Setting it to `FALSE` is convenient to initialize the target `datadir` with a `meta.yaml` file. If a `meta.yaml` file already exists in `datadir`, then this function will stop unconditionally. Move the `datadir/meta.yaml` out of the way if you simply want to refresh it with the default version.

A local datadir needs to be created and initialized (wth a meta.yaml file), to house ARCHS4 data for use in an Archs4Repository. This function creates that datadir and copies an initial meta.yaml file.

Please refer to the vignette section "ARCHS4 Data Download" for more details.

invisibly returns the path to the meta.yaml in the target datadir

denalitherapeutics/archs4 documentation built on May 17, 2019, 1:29 p.m.