starter

A package to help get new projects started with templates

https://github.com/ddsjoberg/starter

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.7%) to scientific vocabulary

Keywords

r r-package rstats template
Last synced: 6 months ago · JSON representation

Repository

A package to help get new projects started with templates

Basic Info
Statistics
  • Stars: 27
  • Watchers: 2
  • Forks: 3
  • Open Issues: 0
  • Releases: 17
Topics
r r-package rstats template
Created over 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Support

README.Rmd

---
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.

Owner

  • Name: Daniel Sjoberg
  • Login: ddsjoberg
  • Kind: user
  • Location: San Francisco Bay Area
  • Company: Genentech

Senior Principal Data Scientist @Genentech; previously @sloan_kettering; Golden Girls Superfan

GitHub Events

Total
  • Create event: 1
  • Issues event: 1
  • Release event: 1
  • Watch event: 2
  • Push event: 4
Last Year
  • Create event: 1
  • Issues event: 1
  • Release event: 1
  • Watch event: 2
  • Push event: 4

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 116
  • Total Committers: 3
  • Avg Commits per committer: 38.667
  • Development Distribution Score (DDS): 0.06
Past Year
  • Commits: 24
  • Committers: 1
  • Avg Commits per committer: 24.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Daniel Sjoberg d****g@g****m 109
Sjoberg S****D@m****g 6
carokos 9****s 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 29
  • Total pull requests: 20
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 0.52
  • Average comments per pull request: 0.25
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: about 5 hours
  • Average time to close pull requests: about 1 hour
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 2.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ddsjoberg (26)
  • slobaugh (1)
  • IndrajeetPatil (1)
  • carokos (1)
Pull Request Authors
  • ddsjoberg (18)
  • yihui (2)
  • carokos (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 387 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 13
  • Total maintainers: 1
cran.r-project.org: starter

Starter Kit for New Projects

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 387 Last month
Rankings
Stargazers count: 12.2%
Forks count: 14.2%
Average: 20.6%
Dependent repos count: 24.0%
Downloads: 24.0%
Dependent packages count: 28.8%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/pr-fetch v2 composite
  • r-lib/actions/pr-push v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 3.4 depends
  • R.utils >= 2.11.0 imports
  • cli >= 3.0.0 imports
  • dplyr >= 1.0.7 imports
  • gert >= 1.4.1 imports
  • glue >= 1.4.2 imports
  • here >= 1.0.1 imports
  • renv >= 0.14.0 imports
  • rlang >= 0.4.11 imports
  • rstudioapi * imports
  • covr >= 3.5.1 suggests
  • fs >= 1.5.0 suggests
  • knitr >= 1.34 suggests
  • pkgdown >= 1.6.1 suggests
  • readr >= 2.0.1 suggests
  • rmarkdown >= 2.11 suggests
  • spelling >= 2.2 suggests
  • testthat >= 3.0.4 suggests