• Stars
    star
    809
  • Rank 54,324 (Top 2 %)
  • Language
    R
  • License
    Other
  • Created over 7 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Set up commonly used πŸ“¦ components

usethis usethis website

R-CMD-check Codecov test coverage CRAN status Lifecycle: stable .github/workflows/R-CMD-check

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:

install.packages("usethis")

Or install the development version from GitHub with:

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

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.

library(usethis)

# Create a new package -------------------------------------------------
path <- file.path(tempdir(), "mypkg")
create_package(path)
#> βœ” Creating '/tmp/RtmpMuqeSm/mypkg/'.
#> βœ” Setting active project to "/private/tmp/RtmpMuqeSm/mypkg".
#> βœ” Creating 'R/'.
#> βœ” Writing 'DESCRIPTION'.
#> Package: mypkg
#> Title: What the Package Does (One Line, Title Case)
#> Version: 0.0.0.9000
#> Authors@R (parsed):
#>     * First Last <[email protected]> [aut, cre] (YOUR-ORCID-ID)
#> Description: What the package does (one paragraph).
#> License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a
#>     license
#> Encoding: UTF-8
#> Roxygen: list(markdown = TRUE)
#> RoxygenNote: 7.3.1
#> βœ” Writing 'NAMESPACE'.
#> βœ” Setting active project to "<no active project>".
# only needed since this session isn't interactive
proj_activate(path)
#> βœ” Setting active project to "/private/tmp/RtmpMuqeSm/mypkg".
#> βœ” Changing working directory to '/tmp/RtmpMuqeSm/mypkg/'

# Modify the description ----------------------------------------------
use_mit_license("My Name")
#> βœ” Adding "MIT + file LICENSE" to 'License'.
#> βœ” Writing 'LICENSE'.
#> βœ” Writing 'LICENSE.md'.
#> βœ” Adding "^LICENSE\\.md$" to '.Rbuildignore'.

use_package("ggplot2", "Suggests")
#> βœ” Adding ggplot2 to 'Suggests' field in DESCRIPTION.
#> ☐ Use `requireNamespace("ggplot2", quietly = TRUE)` to test if ggplot2 is
#>   installed.
#> ☐ Then directly refer to functions with `ggplot2::fun()`.

# Set up other files -------------------------------------------------
use_readme_md()
#> βœ” Writing 'README.md'.
#> ☐ Update 'README.md' to include installation instructions.

use_news_md()
#> βœ” Writing 'NEWS.md'.

use_test("my-test")
#> βœ” Adding testthat to 'Suggests' field in DESCRIPTION.
#> βœ” Adding "3" to 'Config/testthat/edition'.
#> βœ” Creating 'tests/testthat/'.
#> βœ” Writing 'tests/testthat.R'.
#> βœ” Writing 'tests/testthat/test-my-test.R'.
#> ☐ Edit 'tests/testthat/test-my-test.R'.

x <- 1
y <- 2
use_data(x, y)
#> βœ” Adding R to 'Depends' field in DESCRIPTION.
#> βœ” Creating 'data/'.
#> βœ” Setting 'LazyData' to "true" in 'DESCRIPTION'.
#> βœ” Saving "x" and "y" to "data/x.rda" and "data/y.rda".
#> ☐ Document your data (see <https://r-pkgs.org/data.html>).

# Use git ------------------------------------------------------------
use_git()
#> βœ” Initialising Git repo.
#> βœ” Adding ".Rproj.user", ".Rhistory", ".Rdata", ".httr-oauth", ".DS_Store", and
#>   ".quarto" to '.gitignore'.

Code of Conduct

Please note that the usethis project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,350
star
2

lintr

Static Code Analysis for R
R
1,155
star
3

httr

httr: a friendly http package for R
R
978
star
4

actions

GitHub Actions for the R community
JavaScript
898
star
5

testthat

An R πŸ“¦ to make testing πŸ˜€
R
860
star
6

pkgdown

Generate static html documentation for an R package
R
692
star
7

styler

Non-invasive pretty printing of R code
R
674
star
8

pak

A fresh approach to package installation
C
605
star
9

cli

Tools for making beautiful & useful command line interfaces
R
597
star
10

roxygen2

Generate R package documentation from inline R comments
R
574
star
11

rig

The R Installation Manager
Rust
503
star
12

rlang

Low-level API for programming with R
R
475
star
13

progress

Progress bar in your R terminal
R
450
star
14

R6

Encapsulated object-oriented programming for R
R
398
star
15

here

A simpler way to find your files
R
394
star
16

scales

Tools for ggplot2 scales
R
379
star
17

fs

Provide cross platform file operations based on libuv.
C
356
star
18

covr

Test coverage reports for R
R
327
star
19

rex

Friendly regular expressions for R.
R
323
star
20

crayon

πŸ–οΈ R package for colored terminal output β€” now superseded by cli
R
319
star
21

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
313
star
22

memoise

Easy memoisation for R
R
312
star
23

lobstr

Understanding complex R objects with tools similar to str()
R
295
star
24

callr

Call R from R
R
282
star
25

waldo

Find differences between R objects
R
274
star
26

vctrs

Generic programming with typed R vectors
C
273
star
27

slider

Sliding Window Functions
R
272
star
28

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
249
star
29

conflicted

An alternative conflict resolution strategy for R
R
242
star
30

bench

High Precision Timing of R Expressions
R
237
star
31

gmailr

Access the Gmail RESTful API from R.
R
231
star
32

processx

Execute and Control Subprocesses from R
C
227
star
33

asciicast

Turn R scripts into terminal screencasts
R
217
star
34

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
215
star
35

xml2

Bindings to libxml2
R
213
star
36

gh

Minimalistic GitHub API client in R
R
213
star
37

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
190
star
38

keyring

πŸ” Access the system credential store from R
R
187
star
39

vdiffr

Visual regression testing and graphical diffing with testthat
C++
178
star
40

svglite

A lightweight svg graphics device for R
C++
177
star
41

pillar

Format columns with colour
R
172
star
42

withr

Methods For Temporarily Modifying Global State
R
167
star
43

ragg

Graphic Devices Based on AGG
C++
167
star
44

hugodown

Make websites with hugo and RMarkdown
R
164
star
45

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
162
star
46

rprojroot

Finding files in project subdirectories
R
147
star
47

coro

Coroutines for R
R
146
star
48

debugme

Easy and efficient debugging for R packages
R
142
star
49

available

Check if a package name is available to use
R
141
star
50

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
139
star
51

ellipsis

Tools for Working with ...
R
138
star
52

later

Schedule an R function or formula to run after a specified period of time.
C++
135
star
53

gert

Simple git client for R
C
135
star
54

itdepends

R
133
star
55

rray

Simple Arrays
R
130
star
56

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
57

fastmap

Fast map implementation for R
C++
128
star
58

prettyunits

Pretty, human readable formatting of quantities
JavaScript
125
star
59

desc

Manipulate DESCRIPTION files
R
121
star
60

tidyselect

A backend for functions taking tidyverse selections
R
120
star
61

gargle

Infrastructure for calling Google APIs from R, including auth
R
111
star
62

rcmdcheck

Run R CMD check from R and collect the results
R
109
star
63

evaluate

A version of eval for R that returns more information about what happened
R
106
star
64

prettycode

Syntax highlight R code in the terminal
R
99
star
65

sloop

S language OOP ⛡️
R
99
star
66

mockery

A mocking library for R.
R
98
star
67

revdepcheck

R package reverse dependency checking
R
95
star
68

clock

A Date-Time Library for R
R
94
star
69

pkgdepends

R Package Dependency Resolution
R
93
star
70

systemfonts

System Native Font Handling in R
C++
91
star
71

lifecycle

Manage the life cycle of your exported functions and arguments
R
91
star
72

gtable

The layout packages that powers ggplot2
R
84
star
73

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
83
star
74

askpass

Password Entry for R, Git, and SSH
R
82
star
75

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
76

zip

Platform independent zip compression via miniz
C
81
star
77

tree-sitter-r

C
81
star
78

downlit

Syntax Highlighting and Automatic Linking
R
80
star
79

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
75
star
80

sessioninfo

Print Session Information
R
72
star
81

ps

R package to query, list, manipulate system processes
C
71
star
82

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
83

credentials

Tools for Managing SSH and Git Credentials
R
69
star
84

roxygen2md

Convert elements of roxygen documentation to markdown
R
68
star
85

sodium

R bindings to libsodium
R
66
star
86

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
87

pkgbuild

Find tools needed to build R packages
R
65
star
88

cliapp

Rich Command Line Applications
R
61
star
89

webfakes

Fake web apps for HTTP testing R packages
C
60
star
90

generics

Common generic methods
R
58
star
91

diffviewer

HTML widget to visually compare files
JavaScript
56
star
92

liteq

Serverless R message queue using SQLite
R
56
star
93

pkgload

Simulate installing and loading a package
R
54
star
94

cachem

Key-value caches for R
R
53
star
95

carrier

Create standalone functions for remote execution
R
50
star
96

brio

Basic R Input Output
R
50
star
97

jose

Javascript Object Signing and Encryption for R
R
48
star
98

urlchecker

Run CRAN URL checks from older versions of R
R
45
star
99

pkgconfig

Private configuration for R packages
R
40
star
100

filelock

Cross platform file locking in R
R
39
star