kb_read_rds: Share RDS files with other Keybase users

In hrbrmstr/keybase: Tools to Work with the 'Keybase' 'API'

Share RDS files with other Keybase users

Description

Specify the user(s) you want to share an R object with in a character vector using the Keybase user conventions outline in their kbfs introduction. You do not need to specify yourself (the function takes care of adding you).

Usage

kb_read_rds(kb_users, path)

kb_write_rds(x, kb_users, path, compress = c("none", "gz", "bz2", "xz"), ...)

Arguments

kb_users	character vector of (other) Keybase user(s)
path	Relative path to read from/write to.
x	R object to write to serialise.
compress	Compression method to use: "none", "gz" ,"bz", or "xz".
...	Additional arguments to connection function. For example, control the space-time trade-off of different compression methods with compression. See connections() for more details.

Details

Order of usernames does not matter as Keybase is smart enough to create and resolve dynamic symbolic links of all user combos.

Value

write_rds() returns x, invisibly.

Examples

## Not run: 
kb_write_rds(mtcars, "marked", "reprex.rds")
kb_read_rds("marked", "reprex.rds")

## End(Not run)

hrbrmstr/keybase documentation built on May 16, 2022, 6:58 a.m.