Help for package jot

Title:

Jot Down Values for Later

Version:

0.0.4

Description:

Reproducible work requires a record of where every statistic originated. When writing reports, some data is too big to load in the same environment and some statistics take a while to compute. This package offers a way to keep notes on statistics, simple functions, and small objects. Notepads can be locked to avoid accidental updates. Notepads keep track of who added the notes and when the notes were added. A simple text representation is used to allow for clear version histories.

License:

MIT + file LICENSE

Encoding:

UTF-8

RoxygenNote:

7.2.1

Imports:

cli, yaml

URL:

http://christophertkenny.com/jot/, https://github.com/christopherkenny/jot

BugReports:

https://github.com/christopherkenny/jot/issues

NeedsCompilation:

Packaged:

2022-08-27 01:47:06 UTC; chris

Author:

Christopher T. Kenny

[aut, cre]

Maintainer:

Christopher T. Kenny <christopherkenny@fas.harvard.edu>

Repository:

CRAN

Date/Publication:

2022-08-27 15:00:01 UTC

Get Current User

Description

Get Current User

Usage

get_jot_user(user = "")

Arguments

user

user to override get with. Default is '', where it checks options, then system info.

Value

character

Examples

get_jot_user()
get_jot_user(NA_character_)

Get System Time as Integer

Description

Get System Time as Integer

Usage

get_sys_time()

Value

integer

Examples

get_sys_time()

Jot Down a Note

Description

Jot Down a Note

Usage

jot(
  note,
  name,
  overwrite = FALSE,
  user = get_jot_user(),
  time = get_sys_time(),
  pad = jot_active()
)

write_jot(
  note,
  name,
  overwrite = FALSE,
  user = get_jot_user(),
  time = get_sys_time(),
  pad = jot_active()
)

Arguments

note

data to save. required.

name

character, name of data. required.

overwrite

logical, default is FALSE. If a note of the same name exists, should it be overwritten?

user

name of user. default is get_jot_user().

time

system time. default is get_sys_time().

pad

path to file of pad to write to. default is jot_active().

Value

path to pad, invisibly

Examples

tf <- tempfile()
jot_new_pad(tf)
jot_activate(tf)
jot(3, 'example')

Erase a Note

Description

Erase a Note

Usage

jot_erase(name, pad = jot_active())

Arguments

name

character, name of note to erase. required.

pad

path to file of pad to write to. default is jot_active().

Value

path to pad, invisibly

Examples

tf <- tempfile()
jot_new_pad(tf)
jot(3, 'example')
jot_erase('example')

List out names of values in a jot notepad

Description

List out names of values in a jot notepad

Usage

jot_list(pad = jot_active())

Arguments

pad

path to notepad to open

Value

vlist of names of values in notepad

Examples

tf <- tempfile()
jot_new_pad(tf)
jot_activate(tf)
jot('ex_val', 'ex')
jot_list()

Lock or Unlock a jot Notepad

Description

jot_lock() locks a notepad so that jot will not write to it.
jot_unlock() unlocks a notepad so that jot can write to it.

Usage

jot_lock(pad = jot_active())

jot_unlock(pad = jot_active())

Arguments

pad

path to file to open

Value

path to pad, invisibly

Examples

tf <- tempfile()
jot_new_pad(tf)
jot_activate(tf)
jot_lock()
jot_unlock()

Create new jot Notepad

Description

Create new jot Notepad

Usage

jot_new_pad(pad = ".jot.yaml", title)

jot_new(pad = ".jot.yaml", title)

Arguments

pad

path to file to store new notepad.

title

what to call the notepad. If not supplied, uses the name of the file.

Value

path to file, invisibly

Examples

tf <- tempfile()
jot_new_pad(tf)

Open and Close jot Notepads

Description

jot_open() and jot_activate() opens an existing notepad and sets it to active.
jot_current() and jot_active() return the path to the current notepad.
jot_close() and jot_deactivate() closes the open notepad, if there is one.

Usage

jot_open(pad)

jot_activate(pad)

jot_active()

jot_current()

jot_close()

jot_deactivate()

Arguments

pad

path to file to open

Value

path to pad, invisibly

Examples

tf <- tempfile()
jot_new_pad(tf)
jot_open(tf)
jot_active()
jot_current()
jot_close()
jot_active()

Read a jot notepad

Description

Read a jot notepad

Usage

jot_read(name, pad = jot_active())

read_jot(name, pad = jot_active())

Arguments

name

name of noteto read

pad

path to file to open

Value

value specified or all values

Examples

tf <- tempfile()
jot_new_pad(tf)
jot_activate(tf)
jot(note = 'ex_note', name = 'ex_name')
jot_read()
jot_read('ex_name')

Read in all values from a jot notepad

Description

Read in all values from a jot notepad

Usage

jot_skim(pad = jot_active())

Arguments

pad

path to file to open

Value

value specified or list of all values

Examples

tf <- tempfile()
jot_new_pad(tf)
jot_activate(tf)
jot('ex_val', 'ex')
jot_skim()