get_feather_path: Get the path to the folder containing the feather files.

In mirvie/mirmisc: Non-Modeling Helper Functions For Mirvie R Coders

Description

This function requires you to have set the environment variable MIRVIE_FEATHER_PATH, which you can do in the ~/.Rprofile file. It should have a line like Sys.setenv(MIRVIE_FEATHER_PATH = "path/to/mirvie/feathers/dir"). If the file doesn't exist, create it and make this the only line in the file. If this is done correctly, this function then forms a path with MIRVIE_FEATHER_PATH as the root directory.

Usage

get_feather_path(..., use_dotenv = TRUE, verify = TRUE)

Arguments

...	Character vectors. Elements of the path. Mostly, you'll leave this blank.
use_dotenv	A flag. If the MIRVIE_FEATHER_PATH environment variable isn't found by the usual R means, check the ~/.env file used by python-dotenv.
verify	A flag. Check that MIRVIE_FEATHER_PATH exists and contains at least one *.feather file. Error if check fails. Default TRUE.

Details

There's a whole vignette explaining this function. To find it, run browseVignettes(package = "mirmisc").

Value

An fs::path.

Examples

## Not run: 
get_feather_path()

## End(Not run)

mirvie/mirmisc documentation built on Dec. 21, 2021, 7 p.m.