gy_save: Save and load encrypted files

View source: R/gy_save.R

gy_saveR Documentation

Save and load encrypted files

Description

Save and load encrypted files

Usage

gy_save(
  ...,
  list = character(),
  file = stop("file must be specified (.rdg file extension is recommended)"),
  users = character(0),
  local_user = TRUE,
  comment = "",
  overwrite = FALSE,
  funs = list(type = "identity"),
  method = "qs"
)

gy_load(
  file = stop("file must be specified (.rdg file extension is recommended)")
)

Arguments

...

one or more R objects to encrypt

list

alternative method to provide R objects to encrypt as a character vector

file

the name of the encrypted file to create/load (a .rdg file extension is recommended)

users

a character vector of (other) users within your current user group for whom the encrypted file will be decryptable. Alternatively, this can be a vector of paths/urls to public keys, or a mixture of the two.

local_user

should the current user also be able to decrypt thw file?

comment

an optional comment that will be sent (unencrypted) along with the

overwrite

if a file with the same name already exists, should it be overwritten?

funs

optional additional encryption steps: this must be the output of a call to gy_key_funs

method

the serialisation method to use (currently either 'qs' or 'base')


ku-awdc/goldeneye documentation built on Jan. 30, 2024, 12:35 a.m.