forked from r-lib/usethis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
89 lines (62 loc) · 3.39 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# usethis <a href="https://usethis.r-lib.org"><img src="man/figures/logo.png" align="right" height="138" alt="usethis website" /></a>
<!-- badges: start -->
[](https://github.com/r-lib/usethis/actions/workflows/R-CMD-check.yaml)
[](https://CRAN.R-project.org/package=usethis)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/r-lib/usethis/actions/workflows/.github/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/r-lib/usethis)
<!-- badges: end -->
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("ggplot2", "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.