https://github.com/ddsjoberg/starter

A package to help get new projects started with templates
https://github.com/ddsjoberg/starter

r r-package rstats template

Last synced: 3 months ago
JSON representation

A package to help get new projects started with templates

• Host: GitHub
• URL: https://github.com/ddsjoberg/starter
• Owner: ddsjoberg
• License: agpl-3.0
• Created: 2021-06-21T23:11:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-15T17:14:53.000Z (3 months ago)
• Last Synced: 2024-10-16T23:44:15.593Z (3 months ago)
• Topics: r, r-package, rstats, template
• Language: R
• Homepage: http://www.danieldsjoberg.com/starter/
• Size: 12.1 MB
• Stars: 25
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

) 

```

# starter 

[![R-CMD-check](https://github.com/ddsjoberg/starter/workflows/R-CMD-check/badge.svg)](https://github.com/ddsjoberg/starter/actions)

[![Codecov test coverage](https://codecov.io/gh/ddsjoberg/starter/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ddsjoberg/starter?branch=main)

[![CRAN status](https://www.r-pkg.org/badges/version/starter)](https://CRAN.R-project.org/package=starter)

The **starter** package provides a toolkit for starting new projects. 

## Installation

Install {starter} from CRAN with:

``` r

install.packages("starter")

```

Install the development version of {starter} from [GitHub](https://github.com/ddsjoberg/starter) with:

``` r

# install.packages('devtools')

devtools::install_github("ddsjoberg/starter")

```

## Example

```{r}

library(starter)

create_project(

  path = fs::path(tempdir(), "My Project Folder"),

  open = FALSE # don't open project in new RStudio session

)

```

## Example Templates

Check out examples of starter templates currently being used.

```r

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](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.