starter

R-CMD-check Codecov test coverage CRAN status

The starter package provides a toolkit for starting new projects.

Installation

Install {starter} from CRAN with:

install.packages("starter")

Install the development version of {starter} from GitHub with:

# install.packages('devtools')
devtools::install_github("ddsjoberg/starter")

Example

library(starter)

create_project(
  path = fs::path(tempdir(), "My Project Folder"),
  open = FALSE # don't open project in new RStudio session
)
#> v Using 'Default Project Template' template
#> v Writing folder 'C:/Users/sjobergd/AppData/Local/Temp/Rtmp27btX5/My Project Folder/'
#> v Writing files 'README.md', '.gitignore', 'My Project Folder.Rproj', '.Rprofile'
#> v Initialising Git repo
#> v Setting active project to '<no active project>'
#> v Initialising renv project
#> * renv infrastructure has been generated for project "C:/Users/sjobergd/AppData/Local/Temp/Rtmp27btX5/My Project Folder".

Example Templates

Check out examples of starter templates currently being used.

devtools::install_github("ddsjoberg/hotfun")
create_project(
  path = fs::path(tempdir(), "My Project Folder"),
  template = hotfun::project_template
)

devtools::install_github("ddsjoberg/bstfun")
create_project(
  path = fs::path(tempdir(), "My Project Folder"),
  template = bstfun::project_templates[["default"]]
)

Code of Conduct

Please note that the starter project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.