{"Package":"usethis","Title":"Automate Package and Project Setup","Version":"3.0.0","Authors@R":"c(\nperson(\"Hadley\", \"Wickham\", , \"hadley@posit.co\", role = \"aut\",\ncomment = c(ORCID = \"0000-0003-4757-117X\")),\nperson(\"Jennifer\", \"Bryan\", , \"jenny@posit.co\", role = c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0002-6983-2759\")),\nperson(\"Malcolm\", \"Barrett\", , \"malcolmbarrett@gmail.com\", role = \"aut\",\ncomment = c(ORCID = \"0000-0003-0299-5825\")),\nperson(\"Andy\", \"Teucher\", , \"andy.teucher@posit.co\", role = \"aut\",\ncomment = c(ORCID = \"0000-0002-7840-692X\")),\nperson(\"Posit Software, PBC\", role = c(\"cph\", \"fnd\"))\n)","Description":"Automate package and project setup tasks that are otherwise\nperformed manually. This includes setting up unit testing, test\ncoverage, continuous integration, Git, 'GitHub', licenses, 'Rcpp',\n'RStudio' projects, and more.","License":"MIT + file LICENSE","URL":"https://usethis.r-lib.org, https://github.com/r-lib/usethis","BugReports":"https://github.com/r-lib/usethis/issues","Depends":"R (>= 3.6)","Imports":"cli (>= 3.0.1), clipr (>= 0.3.0), crayon, curl (>= 2.7), desc\n(>= 1.4.2), fs (>= 1.3.0), gert (>= 1.4.1), gh (>= 1.2.1), glue\n(>= 1.3.0), jsonlite, lifecycle (>= 1.0.0), purrr, rappdirs,\nrlang (>= 1.1.0), rprojroot (>= 1.2), rstudioapi, stats, utils,\nwhisker, withr (>= 2.3.0), yaml","Suggests":"covr, knitr, magick, pkgload (>= 1.3.2.1), rmarkdown,\nroxygen2 (>= 7.1.2), spelling (>= 1.2), styler (>= 1.2.0),\ntestthat (>= 3.1.8)","Config/Needs/website":"r-lib/asciicast, tidyverse/tidytemplate, xml2","Config/testthat/edition":"3","Config/testthat/parallel":"TRUE","Config/testthat/start-first":"github-actions, release","Encoding":"UTF-8","Language":"en-US","RoxygenNote":"7.3.2","NeedsCompilation":"no","Packaged":"2024-07-28 23:07:11 UTC; jenny","Author":"Hadley Wickham [aut] (),\nJennifer Bryan [aut, cre] (),\nMalcolm Barrett [aut] (),\nAndy Teucher [aut] (),\nPosit Software, PBC [cph, fnd]","Maintainer":"Jennifer Bryan ","Repository":"CRAN","Date/Publication":"2024-07-29 07:20:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/usethis_3.0.0.tar.gz","jsonAuthors":[{"name":"Hadley Wickham","email":"hadley@posit.co","maintainer":false},{"name":"Jennifer Bryan","email":"jenny@posit.co","maintainer":true},{"name":"Malcolm Barrett","email":"malcolmbarrett@gmail.com","maintainer":false},{"name":"Andy Teucher","email":"andy.teucher@posit.co","maintainer":false},{"name":"Posit Software, PBC ","email":null,"maintainer":false}],"readme":"\n\n\n# usethis $\"usethis$ \n\n\n\n[![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)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/usethis)](https://CRAN.R-project.org/package=usethis)\n[![Lifecycle:\nstable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)\n[![.github/workflows/R-CMD-check](https://github.com/r-lib/usethis/actions/workflows/.github/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/usethis/actions/workflows/.github/workflows/R-CMD-check.yaml)\n[![Codecov test\ncoverage](https://codecov.io/gh/r-lib/usethis/graph/badge.svg)](https://app.codecov.io/gh/r-lib/usethis)\n\n\nusethis is a workflow package: it automates repetitive tasks that arise\nduring project setup and development, both for R packages and\nnon-package projects.\n\n## Installation\n\nInstall the released version of usethis from CRAN:\n\n``` r\ninstall.packages(\"usethis\")\n```\n\nOr install the development version from GitHub with:\n\n``` r\n# install.packages(\"pak\")\npak::pak(\"r-lib/usethis\")\n```\n\n## Usage\n\nMost `use_*()` functions operate on the *active project*: literally, a\ndirectory on your computer. If you’ve just used usethis to create a new\npackage or project, that will be the active project. Otherwise, usethis\nverifies that current working directory is or is below a valid project\ndirectory and that becomes the active project. Use `proj_get()` or\n`proj_sitrep()` to manually query the project and [read more in the\ndocs](https://usethis.r-lib.org/reference/proj_utils.html).\n\nA few usethis functions have no strong connections to projects and will\nexpect you to provide a path.\n\nusethis is quite chatty, explaining what it’s doing and assigning you\ntasks. `✔` indicates something usethis has done for you. `☐` indicates\nthat you’ll need to do some work yourself.\n\nBelow is a quick look at how usethis can help to set up a package. But\nremember, many usethis functions are also applicable to analytical\nprojects that are not packages.\n\n``` r\nlibrary(usethis)\n\n# Create a new package -------------------------------------------------\npath <- file.path(tempdir(), \"mypkg\")\ncreate_package(path)\n#> ✔ Creating '/tmp/Rtmpyt1hd6/mypkg/'.\n#> ✔ Setting active project to \"/private/tmp/Rtmpyt1hd6/mypkg\".\n#> ✔ Creating 'R/'.\n#> ✔ Writing 'DESCRIPTION'.\n#> Package: mypkg\n#> Title: What the Package Does (One Line, Title Case)\n#> Version: 0.0.0.9000\n#> Authors@R (parsed):\n#> * First Last [aut, cre] (YOUR-ORCID-ID)\n#> Description: What the package does (one paragraph).\n#> License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a\n#> license\n#> Encoding: UTF-8\n#> Roxygen: list(markdown = TRUE)\n#> RoxygenNote: 7.3.2\n#> ✔ Writing 'NAMESPACE'.\n#> ✔ Setting active project to \"\".\n# only needed since this session isn't interactive\nproj_activate(path)\n#> ✔ Setting active project to \"/private/tmp/Rtmpyt1hd6/mypkg\".\n#> ✔ Changing working directory to '/tmp/Rtmpyt1hd6/mypkg/'\n\n# Modify the description ----------------------------------------------\nuse_mit_license(\"My Name\")\n#> ✔ Adding \"MIT + file LICENSE\" to 'License'.\n#> ✔ Writing 'LICENSE'.\n#> ✔ Writing 'LICENSE.md'.\n#> ✔ Adding \"^LICENSE\\\\.md$\" to '.Rbuildignore'.\n\nuse_package(\"ggplot2\", \"Suggests\")\n#> ✔ Adding ggplot2 to 'Suggests' field in DESCRIPTION.\n#> ☐ Use `requireNamespace(\"ggplot2\", quietly = TRUE)` to test if ggplot2 is\n#> installed.\n#> ☐ Then directly refer to functions with `ggplot2::fun()`.\n\n# Set up other files -------------------------------------------------\nuse_readme_md()\n#> ✔ Writing 'README.md'.\n#> ☐ Update 'README.md' to include installation instructions.\n\nuse_news_md()\n#> ✔ Writing 'NEWS.md'.\n\nuse_test(\"my-test\")\n#> ✔ Adding testthat to 'Suggests' field in DESCRIPTION.\n#> ✔ Adding \"3\" to 'Config/testthat/edition'.\n#> ✔ Creating 'tests/testthat/'.\n#> ✔ Writing 'tests/testthat.R'.\n#> ✔ Writing 'tests/testthat/test-my-test.R'.\n#> ☐ Edit 'tests/testthat/test-my-test.R'.\n\nx <- 1\ny <- 2\nuse_data(x, y)\n#> ✔ Adding R to 'Depends' field in DESCRIPTION.\n#> ✔ Creating 'data/'.\n#> ✔ Setting 'LazyData' to \"true\" in 'DESCRIPTION'.\n#> ✔ Saving \"x\" and \"y\" to \"data/x.rda\" and \"data/y.rda\".\n#> ☐ Document your data (see ).\n\n# Use git ------------------------------------------------------------\nuse_git()\n#> ✔ Initialising Git repo.\n#> ✔ Adding \".Rproj.user\", \".Rhistory\", \".Rdata\", \".httr-oauth\", \".DS_Store\", and\n#> \".quarto\" to '.gitignore'.\n```\n\n## Code of Conduct\n\nPlease note that the usethis project is released with a [Contributor\nCode of Conduct](https://usethis.r-lib.org/CODE_OF_CONDUCT.html). By\ncontributing to this project, you agree to abide by its terms.","jobInfo":{"package":"usethis","version":"3.0.0","parsingStatus":"success","parserVersion":2,"parsedAt":"2024-07-29T09:30:06+0000"}}

Description

Usage

Arguments

See Also