set_cancensus_cache_path: Set persistent cancensus cache location

View source: R/user_settings.R

set_cancensus_cache_pathR Documentation

Set persistent cancensus cache location

Description

Cancensus provides session caching for retrieved data to increase speeds and reduce API usage. This function will create a persistent cache across sessions.

Usage

set_cancensus_cache_path(cache_path, overwrite = FALSE, install = FALSE)

Arguments

cache_path

a local directory to use for saving cached data

overwrite

Option to overwrite any existing cache path already stored locally.

install

Option to install permanently for use across sessions.

Examples

## Not run: 
set_cancensus_cache_path("~/cancensus_cache")

# This will set the cache path permanently until overwritten again
set_cancensus_cache_path("~/cancensus_cache", install = TRUE)

## End(Not run)

mountainMath/cancensus documentation built on Feb. 11, 2024, 5:13 p.m.