use_template: Custom template file

Description Usage Arguments Details See Also

Description

Add a template file to the project.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
.use_template(template, save_as = template, package = "teproj", ...)

use_r_profile(template = ".Rprofile", save_as = template, ...)

use_task_schedule(
  template = "schedule-task.R",
  save_as = file.path("R", template),
  ...
)

use_r_buildignore(template = ".Rbuildignore", save_as = template, ...)

use_gitignore(template = ".gitignore", save_as = template, ...)

use_config_yml(template = "config.yml", save_as = template, ...)

Arguments

template

character. Name of template file. Default value is provided.

save_as

character. Location/name of file to save. Default is provided.

package

character. Name of package. Default is name of this package.

...

dots. Arguments passed to usethis::use_template().

Details

Calls usethis::use_template(). Really only would need to use system.file(), file.copy(), etc. if there are no variables to be filled in the template file. (See the data argument of usethis::use_template(). Nonetheless, usethis::use_template()'s additional functionality (e.g. prompting the user about overwriting files) is useful.

See Also

https://github.com/r-lib/usethis/blob/master/R/template.R.


aelhabr/teproj documentation built on June 18, 2020, 3:25 a.m.