Meditate: Run Meditation Timer

Description Usage Arguments Value Author(s) See Also Examples

View source: R/Meditate.R

Description

A simple meditation timer that logs session information.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
Meditate(
  duration = 20,
  interval = NULL,
  repeats = TRUE,
  sound = TRUE,
  preparation = 10,
  file = "meditate.csv",
  mandala = FALSE,
  ...,
  user_stops = FALSE
)

Arguments

duration

'numeric' number. Meditation time in minutes.

interval

'numeric' number. Interval time in minutes.

repeats

'logical' flag. Whether to repeat the time interval.

sound

'logical' flag. Whether to include a start, end, and interval sound. Requires access to an audio driver.

preparation

'numeric' number. Preparation time in seconds.

file

'character' string or 'connection'. File to write session information—new data records will be appended to this comma-separated values (CSV) file. A data record consists of a session's start time in Coordinated Universal Time (UTC) and duration in minutes.

mandala

'logical' flag. Whether to plot a mandala.

...

Arguments passed to the PlotMandala function.

user_stops

'logical' flag. Whether to manually stop the session timer. Allows for extended meditation.

Value

Invisible NULL

Author(s)

J.C. Fisher

See Also

ReadSessions function to read and summarize the exported session information back into R.

Examples

1
2
3
4
5
6
7
meditate::Meditate(0.1, sound = FALSE, preparation = NULL, file = NULL)

## Not run: 
# Begin a 10-minute meditation session with mandala:
meditate::Meditate(10, mandala = TRUE)

## End(Not run)

meditate documentation built on March 26, 2020, 9:37 p.m.