Caching makes styler faster on repeated styling and is shared across all APIs
(e.g. style_text() and Addin).
That means if you style code that already complies to a
style guide and you have previously styled that code, it will be quicker.
See cache_info(),cache_activate() or cache_clear() for utilities to
manage the cache. You can deactivate it altogether with cache_deactivate().
Since we leverage {R.cache} to manage the cache, you can also use any
{R.cache} functionality to manipulate it.
In some cases, you want to use a non-standard cache location. In
that situation, you can set the path to the cache with the R option
R.cache.rootPath or the environment variable R_CACHE_ROOTPATH to an
existent path before you call the styler API.
The cache is specific to a version of styler by default, because different versions potentially format code differently. This means after upgrading styler or a style guide you use, the cache will be re-built.
The cache works by storing hashed output code as a whole and by expression, which is why it takes zero space on disk (the cache is a directory with empty files which have the hash of output code as name).
If you want to set up caching in a CI/CD pipeline, we suggest to set the
{R.cache} root path to a directory for which you have the cache enabled as
This can often be set in config files of CI/CD tools, e.g. see the
Travis documentation on caching.
Other cache managers:
cache_activate(),
cache_clear(),
cache_info()