Framework for R

Project Management

config_sync()

Sync Settings from the Python Package and fw

The Python package and the fw command-line tool keep their settings in ~/.config/framework, and the R package keeps its own in fw_config_dir(). config_sync() brings R in line with them: files that are missing from R's folder, or newer in theirs, are copied into R's folder. This covers user settings, the saved Framework Cloud server, and token files. The cloud settings mirror and its sync state stay separate, because each tool keeps its own. R only reads their folder and never writes to it.

Usage

config_sync(from = NULL, dry_run = FALSE)

Arguments

Name Default Description
from NULL

The folder to sync from. Defaults to $XDG_CONFIG_HOME/framework, or ~/.config/framework when XDG_CONFIG_HOME is unset.

dry_run FALSE

Logical. List what would be copied without copying it.

Value

Invisibly, the relative paths copied (or that would be copied).

Details

Logins stored in the system keyring are already shared and need no sync.

Examples

Not run

if (FALSE) {
config_sync(dry_run = TRUE)
config_sync()
}

Related reference