https://github.com/r-lib/usethis

Set up commonly used 📦 components
https://github.com/r-lib/usethis

github package r rstats setup

Last synced: 4 days ago
JSON representation

Set up commonly used 📦 components

• Host: GitHub
• URL: https://github.com/r-lib/usethis
• Owner: r-lib
• License: other
• Created: 2016-11-07T14:33:45.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T19:45:30.000Z (about 2 months ago)
• Last Synced: 2024-10-25T05:58:34.437Z (about 2 months ago)
• Topics: github, package, r, rstats, setup
• Language: R
• Homepage: https://usethis.r-lib.org/
• Size: 22.2 MB
• Stars: 860
• Watchers: 18
• Forks: 286
• Open Issues: 72
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• jimsghstars - r-lib/usethis - Set up commonly used 📦 components (R)

README

        
---

output: github_document

---

```{r 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)

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.