Description Usage Arguments Details Value Examples
Create all the scaffolding for a new project in a new directory. The scaffolding includes a README file, different folders to hold raw data, analyses, etc, and optionally also testthat
infrastructure. Also, optionally, set a private or public GitHub repo with continuous integration (Travis-CI, GitHub Actions...).
1 2 3 4 5 6 7 8 9 10 11 12 13 |
name |
Character. Name of the new project. A new folder will be created with that name. |
path |
Character. Path where the new project should be created (default is the current working directory). |
package |
Logical. Create package structure or a simple project? |
github |
Logical. Create GitHub repository? Note this requires some working infrastructure like |
private.repo |
Logical. Default is TRUE. |
ci |
Logical. Use continuous integration in your GitHub repository? Current options are "none" (default), "travis" (uses Travis-CI), "circle" (uses Circle-CI), "appveyor" (uses AppVeyor), or "gh-actions" (uses GitHub Actions). |
makefile |
Logical. If TRUE, adds a template |
pipe |
Logical. Use magrittr's pipe in your package? |
testthat |
Logical. Add testthat infrastructure? |
verbose |
Print verbose output in the console while creating the new project? Default is FALSE. |
open.project |
Logical. If TRUE (the default) will open the newly created Rstudio project in a new session. |
If using github = TRUE, you will be asked if you want to commit some files. Reply positively to continue.
A new directory with R package structure, slightly modified.
1 2 3 4 5 6 | ## Not run:
library("template")
new_project("myproject")
new_project("myproject", github = TRUE, private.repo = TRUE)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.