usethis

Set up commonly used 📦 components

Science Score: 36.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
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
14 of 170 committers (8.2%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (20.2%) to scientific vocabulary

Keywords

github package r rstats setup

Keywords from Contributors

package-creation tidy-data visualisation grammar data-manipulation rmarkdown documentation-tool tidyverse unit-testing latex

Last synced: 6 months ago · JSON representation

Repository

Set up commonly used 📦 components

Basic Info

Host: GitHub
Owner: r-lib
License: other
Language: R
Default Branch: main
Homepage: https://usethis.r-lib.org/
Size: 24.2 MB

Statistics

Stars: 888
Watchers: 17
Forks: 289
Open Issues: 56
Releases: 24

Topics

github package r rstats setup

Created over 9 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Codeowners Support

README.Rmd

---
output: github_document
---



```{r}
#| label: setup
#| include: false
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# usethis 


[![R-CMD-check](https://github.com/r-lib/usethis/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/usethis/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/usethis)](https://CRAN.R-project.org/package=usethis)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![Codecov test coverage](https://codecov.io/gh/r-lib/usethis/graph/badge.svg)](https://app.codecov.io/gh/r-lib/usethis)
[![R-universe version](https://r-lib.r-universe.dev/usethis/badges/version)](https://r-lib.r-universe.dev/usethis)


usethis is a workflow package: it automates repetitive tasks that arise during project setup and development, both for R packages and non-package projects.

## Installation

Install the released version of usethis from CRAN:

```{r}
#| eval: false
install.packages("usethis")
```

Or install the development version from GitHub with:

```{r}
#| eval: false
# install.packages("pak")
pak::pak("r-lib/usethis")
```

## Usage

Most `use_*()` functions operate on the *active project*: literally, a directory on your computer. If you've just used usethis to create a new package or project, that will be the active project. Otherwise, usethis verifies that current working directory is or is below a valid project directory and that becomes the active project. Use `proj_get()` or `proj_sitrep()` to manually query the project and [read more in the docs](https://usethis.r-lib.org/reference/proj_utils.html).

A few usethis functions have no strong connections to projects and will expect you to provide a path.

usethis is quite chatty, explaining what it's doing and assigning you tasks. `✔` indicates something usethis has done for you. `☐` indicates that you'll need to do some work yourself.

Below is a quick look at how usethis can help to set up a package. But remember, many usethis functions are also applicable to analytical projects that are not packages.

```{r}
#| include: false
# Reset possible options
options(usethis.description = list())
```

```{r}
library(usethis)

# Create a new package -------------------------------------------------
path <- file.path(tempdir(), "mypkg")
create_package(path)
# only needed since this session isn't interactive
proj_activate(path)

# Modify the description ----------------------------------------------
use_mit_license("My Name")

use_package("rmarkdown", "Suggests")

# Set up other files -------------------------------------------------
use_readme_md()

use_news_md()

use_test("my-test")

x <- 1
y <- 2
use_data(x, y)

# Use git ------------------------------------------------------------
use_git()
```

## Code of Conduct

Please note that the usethis project is released with a [Contributor Code of Conduct](https://usethis.r-lib.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

Owner

Name: R infrastructure
Login: r-lib
Kind: organization

Repositories: 154
Profile: https://github.com/r-lib

GitHub Events

Total

Create event: 19
Release event: 1
Issues event: 99
Watch event: 25
Delete event: 28
Issue comment event: 178
Push event: 166
Pull request event: 51
Pull request review event: 57
Pull request review comment event: 70
Fork event: 16

Last Year

Create event: 19
Release event: 1
Issues event: 99
Watch event: 25
Delete event: 28
Issue comment event: 178
Push event: 166
Pull request event: 51
Pull request review event: 57
Pull request review comment event: 70
Fork event: 16

Committers

Last synced: 8 months ago

All Time

Total Commits: 2,803
Total Committers: 170
Avg Commits per committer: 16.488
Development Distribution Score (DDS): 0.587

Past Year

Commits: 82
Committers: 21
Avg Commits per committer: 3.905
Development Distribution Score (DDS): 0.415

Top Committers

Name	Email	Commits
Jenny Bryan	j**n@g**m	1,157
hadley	h**m@g**m	827
Winston Chang	w**n@s**g	180
Jim Hester	j**r@g**m	90
Kirill Müller	k**r@i**h	41
Malcolm Barrett	m****t	38
Andy Teucher	a**r@g**m	30
Mara Averick	m**k@g**m	29
Kirill Müller	k****r	24
Ian Lyttle	i****e	22
jennybc	j**y@s**a	21
Lionel Henry	l**y@g**m	18
olivroy	5****y	17
Davis Vaughan	d**s@r**m	12
Christophe Dervieux	c**x@g**m	10
Geoff99	g**9@g**m	10
Kevin Ushey	k**y@g**m	8
Facundo Muñoz	f**z@o**r	8
Maëlle Salmon	m**n@y**e	7
Mauro Lepore	m**e@g**m	6
Alex Gold	g**x@b**m	6
Yoni Ben-Meshulam	y**h@g**m	6
Michael Chirico	m**o@g**m	5
Kohske Takahashi @ jurina	t**e@g**m	5
Mine Cetinkaya-Rundel	c**e@g**m	5
Jon Harmon	j**k@g**m	4
John Blischak	j**k@g**m	4
Jeroen Ooms	j**s@g**m	4
Jeffrey Girard	me@j****m	4
James J Balamuta	c****s	4
and 140 more...

Committer Domains (Top 20 + Academic)

rstudio.com: 3 me.com: 2 pm.me: 2 mango-solutions.com: 1 normalesup.org: 1 aad.gov.au: 1 pnnl.gov: 1 dcc.uchile.cl: 1 posteo.de: 1 novisci.com: 1 mail.usf.edu: 1 aroma-project.org: 1 mail.utoronto.ca: 1 quartzbio.com: 1 bccrc.ca: 1 google.com: 1 jmgirard.com: 1 grabtaxi.com: 1 bah.com: 1 orleans.inra.fr: 1 stat.ubc.ca: 1 ivt.baug.ethz.ch: 1 usc.edu: 1 nceas.ucsb.edu: 1 ohsu.edu: 1 mail.missouri.edu: 1 cs.purdue.edu: 1 ucdavis.edu: 1 bristol.ac.uk: 1 missouri.edu: 1 psychologie.uni-freiburg.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 259
Total pull requests: 244
Average time to close issues: 6 months
Average time to close pull requests: about 2 months
Total issue authors: 123
Total pull request authors: 51
Average comments per issue: 1.93
Average comments per pull request: 1.29
Merged pull requests: 159
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 68
Pull requests: 58
Average time to close issues: 20 days
Average time to close pull requests: 4 days
Issue authors: 46
Pull request authors: 14
Average comments per issue: 1.25
Average comments per pull request: 1.05
Merged pull requests: 27
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

hadley (39)
jennybc (33)
olivroy (10)
ateucher (10)
DavisVaughan (9)
maelle (6)
kevinushey (6)
MichaelChirico (5)
Bisaloo (4)
ramiromagno (4)
coatless (3)
JosiahParry (3)
Aariq (3)
jonthegeek (3)
programgirl (2)

Pull Request Authors

olivroy (51)
jennybc (44)
hadley (24)
ateucher (21)
DavisVaughan (9)
pachadotdev (6)
krlmlr (5)
lionel- (4)
focardozom (4)
cynthiahqy (4)
jplecavalier (4)
MichaelChirico (3)
thomasp85 (3)
salim-b (3)
florisvdh (2)

Top Labels

Issue Labels

feature (53) git (24) tidy-dev-day :nerd_face: (20) release :flight_departure: (17) tidy :sparkles: (16) upkeep :broom: (14) bug (11) description :books: (10) code :desktop_computer: (9) documentation (8) readme :house: (7) docs 💡 (7) wip (5) tooling :hammer: (5) paths 🚶‍♂️ (3) upkeep (3) course :woman_teacher: (2) good first issue :heart: (2) edit 🧞‍♂️ (2) help wanted :heart: (1) reprex (1) non-package (1)

Pull Request Labels

tidy-dev-day :nerd_face: (2)

Packages

Total packages: 2
Total downloads:
- cran 149,351 last-month
Total docker downloads: 47,543,372

Total dependent packages: 244
(may contain duplicates)
Total dependent repositories: 1,176
(may contain duplicates)
Total versions: 51
Total maintainers: 1

cran.r-project.org: usethis

Automate Package and Project Setup

Homepage: https://usethis.r-lib.org
Documentation: http://cran.r-project.org/web/packages/usethis/usethis.pdf
License: MIT + file LICENSE
Latest release: 3.2.1
published 6 months ago

Versions: 25
Dependent Packages: 244
Dependent Repositories: 1,176
Downloads: 149,351 Last month
Docker Downloads: 47,543,372

Rankings

Forks count: 0.2%

Stargazers count: 0.4%

Dependent repos count: 0.4%

Dependent packages count: 0.5%

Downloads: 0.9%

Average: 3.3%

Docker downloads count: 17.3%

Maintainers (1)

jenny@posit.co

Last synced: 6 months ago

proxy.golang.org: github.com/r-lib/usethis

Documentation: https://pkg.go.dev/github.com/r-lib/usethis#section-documentation
License: other
Latest release: v3.2.0+incompatible
published 6 months ago

Versions: 26
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.5%

Average: 5.7%

Dependent repos count: 5.9%

Last synced: 6 months ago

Dependencies

DESCRIPTION cran

R >= 3.4 depends
cli >= 3.0.1 imports
clipr >= 0.3.0 imports
crayon * imports
curl >= 2.7 imports
desc >= 1.4.0 imports
fs >= 1.3.0 imports
gert >= 1.4.1 imports
gh >= 1.2.1 imports
glue >= 1.3.0 imports
jsonlite * imports
lifecycle >= 1.0.0 imports
purrr * imports
rappdirs * imports
rlang >= 1.0.0 imports
rprojroot >= 1.2 imports
rstudioapi * imports
stats * imports
utils * imports
whisker * imports
withr >= 2.3.0 imports
yaml * imports
covr * suggests
knitr * suggests
magick * suggests
mockr * suggests
pkgload * suggests
rmarkdown * suggests
roxygen2 >= 7.1.2 suggests
spelling >= 1.2 suggests
styler >= 1.2.0 suggests
testthat >= 3.1.0 suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 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/lint-undesirable-functions.yaml actions

actions/checkout v3 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 v4.4.1 composite
actions/checkout v3 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 v3 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 v3 composite
actions/upload-artifact v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite