get-set-barrier-strings: Get and set barrier strings

In echasnovski/cursorjumper: Jump Cursor

Description

These functions get and set 'cursorjumper' barrier strings which will be used in jump() for a decision making whether to perform a jump.

Usage

set_barrier_strings(barrier_strings)

get_barrier_strings()

Arguments

barrier_strings

A character vector for barrier strings (there should be no empty strings) or NULL (to reset to default values).

Details

Note that symbols in barrier_strings shouldn't be explicitly escaped, i.e. they should be in the form present in RStudio.

Value

set_barrier_strings() returns call to options() after setting barrier strings. get_barrier_strings() returns currently set barrier strings (if nothing was set explicitly, it returns default barrier strings).

Examples

## Not run: 
# If nothing is set, it returns default barriers
barriers <- get_barrier_strings()

# Here " symbol shouldn't be explicitly escaped
set_barrier_strings(c("a", '"]'))
get_barrier_strings()

set_barrier_strings(barriers)

## End(Not run)

echasnovski/cursorjumper documentation built on May 21, 2020, 9:02 p.m.