person: Update a person file.

In loelschlaeger/personfiles: Notes About Persons In Your Life

Description

This function creates, prints, extends, deletes, or modifies the file for person name.

Usage

person(
  name = "all",
  note = NULL,
  delete = NULL,
  password = NULL,
  folder_dir = "."
)

Arguments

name	The person's name.
note	A note for person name.
delete	A number or a vector of numbers, which correspond to the notes that get deleted. If delete = "all", the whole person file gets deleted.
password	The folder's password. Can be NULL for no password.
folder_dir	The directory for the folder. Set folder_dir = "." for the current directory.

Details

Internally, name is transformed to a string which can be properly saved by transform_name. The file for name is

• created, if name does not exist,

• printed, if name does exist,

• extended by note, if note is specified,

• deleted, if delete = "all",

• modified (i.e. the notes with the numbers specified in delete) get deleted, if delete is a vector of numbers.

Set name = "all" to print all saved person files.

Value

Returns invisibly the updated folder (which is an object of class personfiles). The folder also is saved in folder_dir.

Examples

### Create encrypted folder.
folder_dir <- tempdir()
folder(password = "secret", folder_dir = folder_dir, overwrite = TRUE)
### Create person file for John Doe.
person(name = "John Doe", note = "Likes chess.", password = "secret",
       folder_dir = folder_dir)
### Add another note for John Doe.
person(name = "John Doe", note = "Always plays 1.e4.", password = "secret",
       folder_dir = folder_dir)
### Print person file for John Doe.
person(name = "John Doe", password = "secret", folder_dir = folder_dir)
### Create person file for Jane Doe.
person(name = "Jane Doe", note = "Married to John Doe.",
       password = "secret", folder_dir = folder_dir)
### Print all person files.
person(name = "all", password = "secret", folder_dir = folder_dir)
### Delete note 'Always plays 1.e4.' of John Doe.
person(name = "John Doe", delete = 2, password = "secret",
       folder_dir = folder_dir)
### Delete file of Jane Doe.
person(name = "Jane Doe", delete = "all", password = "secret",
       folder_dir = folder_dir)

loelschlaeger/personfiles documentation built on Dec. 21, 2021, 11:45 a.m.