archs4_file_path: Identify the file path on the system for specific ARCHS4...

In denalitherapeutics/archs4: Wrappers to query and extract ARCHS4 data

Description

By default, this function will throw an error if a file does not exist upon lookup. To return the expected path to the, even if it does not exist on the file system, set stop_if_missing = FALSE.

Usage

file_path(x, key)

archs4_file_path(key, stop_if_missing = TRUE, na_missing = TRUE,
  file_info = archs4_file_info(datadir),
  datadir = getOption("archs4.datadir"))

Arguments

x	an Archs4Repository
key	the lookup key for the file, ie. "human_gene" or "mouse_gene". The known keys are enumerated in archs4_file_info()$key column.
stop_if_missing	defaults to TRUE, which causes this function to throw an error if the file does not exist at the expected file_path. Set this to FALSE to simply raise a warning
na_missing	by default, we set paths to files that don't exist to NA. Set this to FALSE to retrieve the expected path of the missing file.
file_info	the output from archs4_file_info(), which enumerates the files used by the Archs4Repository.
datadir	the directory that stores the ARCHS4 data files

Value

a named (by key) character vector of paths to the filesystem that correspond to the entries in key.

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