edit_file: Open file for editing

Description Usage Arguments Value Examples

View source: R/edit.R

Description

Opens a file for editing in RStudio, if that is the active environment, or via utils::file.edit() otherwise. If the file does not exist, it is created. If the parent directory does not exist, it is also created. edit_template() specifically opens templates in inst/templates for use with use_template().

Usage

1
2
3
edit_file(path, open = rlang::is_interactive())

edit_template(template = NULL, open = rlang::is_interactive())

Arguments

path

Path to target file.

open

Whether to open the file for interactive editing.

template

The target template file. If not specified, existing template files are offered for interactive selection.

Value

Target path, invisibly.

Examples

1
2
3
4
5
## Not run: 
edit_file("DESCRIPTION")
edit_file("~/.gitconfig")

## End(Not run)

usethis documentation built on Feb. 10, 2021, 5:08 p.m.