README.md

In starter: Starter Kit for New Projects

starter

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
)
#> ✔ Using "Default Project Template" template
#> ✔ Writing folder '/var/folders/6f/gdjf_vxj2wl3jhmxdkd1hd_w0000gn/T/RtmpTUywzl/My Project Folder'
#> ✔ Writing files "README.md", ".gitignore", "My Project Folder.Rproj", and ".Rprofile"
#> ✔ Initialising Git repo
#> ✔ Initialising renv project
#> - Lockfile written to "/private/var/folders/6f/gdjf_vxj2wl3jhmxdkd1hd_w0000gn/T/RtmpTUywzl/My Project Folder/renv.lock".
#> - renv infrastructure has been generated for project "/private/var/folders/6f/gdjf_vxj2wl3jhmxdkd1hd_w0000gn/T/RtmpTUywzl/My Project Folder".

Example Templates

Check out examples of starter templates currently being used.

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

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.

starter documentation built on Oct. 15, 2024, 5:06 p.m.