sfa_set_cache_dir: Set cache directory globally

View source: R/sfa_set_cache_dir.R

sfa_set_cache_dirR Documentation

Set cache directory globally

Description

It is highly recommended to set the cache directory globally. This has two advantages:

  1. Results from the 'SimFin' API calls are cached over the end of the session. This is especially interesting if you don't have a SimFin+ account and the number of API calls is limited to 2,000 per day.

  2. It makes specifying the cache_dir argument of other ⁠sfa_*⁠ functions obsolete.

Usage

sfa_set_cache_dir(path, create = FALSE)

Arguments

path

character The directory where you want to cache the responses from the 'SimFin' API calls.

create

logical Set TRUE if you want to create path automatically if it does not yet exist.

Value

character The cache directory (invisibly).


simfinapi documentation built on May 29, 2024, 3:12 a.m.