Opens the scribblr
note editor in a new window.
scribble(note = NULL)
either NULL
, or a length one character (not NA
).
See details.
returns NULL
, invisibly. Called for side-effects.
scribblr
integrates a minimalist note editor within RStudio,
useful for taking quick project-related notes without distractions.
scribblr
notes are RStudio project aware: each project has associated
its own notes, which can be accessed by calling scribble()
, and are
stored into the project's root directory. Using scribble()
without
any active project will take the R home directory as root.
Calling scribble()
with the default note = NULL
gives access to
the main project notes. Otherwise, note
must be a string specifying a
valid filename.
scribblr
notes and settings for the active project are stored in the
".scribblr"
directory, under the project's root. If this, or the note
specified by note
, do not exist, the user will be prompted for
permission to create the required files/directories.
Notes are autosaved when the editor is closed; until that moment, the R session will remain busy.
scribble()
can also be called (and, in particular, associated a
custom keystroke) via the RStudio Addin "Open scribblr note editor".
if (FALSE) {
scribble()
}