snippr (version 0.0.0.9000)

snippet_remove: Remove a snippet from a .snippets file.

Description

Remove a snippet from a .snippets file, raising an error if the snippet is not found in the file.

Usage

snippet_remove(name, language = "r", path = snippets_path(language),
  error = TRUE)

Arguments

name

of the snippet to remove

language

language of the snippet. Choices are "r", "c_cpp", "html", "css", "java", "javascript", "python", and "sql". Ignored if path is specified.

path

path to .snippets file

error

whether to raise an error if the snippet is not found

Details

Note that a .snippets file for a language may not yet exist. If it does not exist, go to Preferences->Code->Edit Snippets in RStudio, make a trivial change to the language of choice (for example, a new empty line), and click Save. This will create the language file in ~/.R/snippets/<language>.snippets with defaults included.

Examples

# NOT RUN {
# add a .r snippet
snippet_add("dplyr", "${1:object} <- ${1:object} %>%\n${2:function}")

# remove the snippet
snippet_remove("dplyr")

# }