reminder {findR}

Find reminders on how to use a specific R function

Description

reminder scans all directories and subdirectories of a given path for files (.R, .Rmd, .txt) containing a specific R function and prints the corresponding lines of code.

Usage

reminder(func = "library", path = ".", before = 0, after = 0,
  stepwise = TRUE)

Arguments

func

a function to search for.

path

a character vector, path to be scanned. The default corresponds to the working directory, getwd().

before

integer. The number of lines to print before the function.

after

integer. The number of lines to print after the function.

stepwise

a logical value. If TRUE, examples are shown one by one using prompt.

Examples

# Find reminder on how to use the function chordDiagram
reminder(func = "chordDiagram", path = system.file(package = "findR"), stepwise = FALSE)