{"Package":"usethis","Title":"Automate Package and Project Setup","Version":"1.6.0","Authors@R":"\nc(person(given = \"Hadley\",\nfamily = \"Wickham\",\nrole = \"aut\",\nemail = \"hadley@rstudio.com\",\ncomment = c(ORCID = \"0000-0003-4757-117X\")),\nperson(given = \"Jennifer\",\nfamily = \"Bryan\",\nrole = c(\"aut\", \"cre\"),\nemail = \"jenny@rstudio.com\",\ncomment = c(ORCID = \"0000-0002-6983-2759\")),\nperson(given = \"RStudio\",\nrole = c(\"cph\", \"fnd\")))","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', 'RStudio'\nprojects, and more.","License":"GPL-3","URL":"https://usethis.r-lib.org, https://github.com/r-lib/usethis","BugReports":"https://github.com/r-lib/usethis/issues","Depends":"R (>= 3.2)","Imports":"clipr (>= 0.3.0), cli, crayon, curl (>= 2.7), desc, fs (>=\n1.3.0), gh (>= 1.1.0), git2r (>= 0.23), glue (>= 1.3.0), purrr,\nrematch2, rlang (>= 0.4.3), rprojroot (>= 1.2), rstudioapi,\nstats, utils, whisker, withr, yaml","Suggests":"covr, knitr, magick, pkgdown (>= 1.4.0), rmarkdown, roxygen2,\nspelling (>= 1.2), styler (>= 1.2.0), testthat (>= 2.1.0)","Encoding":"UTF-8","Language":"en-US","LazyData":"true","RoxygenNote":"7.1.0","NeedsCompilation":"no","Packaged":"2020-04-06 19:15:56 UTC; hadley","Author":"Hadley Wickham [aut] (),\nJennifer Bryan [aut, cre] (),\nRStudio [cph, fnd]","Maintainer":"Jennifer Bryan ","Repository":"CRAN","Date/Publication":"2020-04-09 04:50:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/usethis_1.6.0.tar.gz","jsonAuthors":[{"name":"Hadley Wickham","email":"hadley@rstudio.com","maintainer":false},{"name":"Jennifer Bryan","email":"jenny@rstudio.com","maintainer":true},{"name":"RStudio ","email":null,"maintainer":false}],"readme":"\n\n\n# usethis

\n\n\n\n[![R build\nstatus](https://github.com/r-lib/usethis/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/usethis/actions)\n[![Codecov test\ncoverage](https://codecov.io/gh/r-lib/usethis/branch/master/graph/badge.svg)](https://codecov.io/gh/r-lib/usethis?branch=master)\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://www.tidyverse.org/lifecycle/#stable)\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(\"devtools\")\ndevtools::install_github(\"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/RtmppskQJj/mypkg/'\n#> ✓ Setting active project to '/private/tmp/RtmppskQJj/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] ()\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#> LazyData: true\n#> Roxygen: list(markdown = TRUE)\n#> RoxygenNote: 7.1.0\n#> ✓ Writing 'NAMESPACE'\n#> ✓ Setting active project to ''\n# only needed since this session isn't interactive\nproj_activate(path)\n#> ✓ Changing working directory to '/tmp/RtmppskQJj/mypkg/'\n#> ✓ Setting active project to '/private/tmp/RtmppskQJj/mypkg'\n\n# Modify the description ----------------------------------------------\nuse_mit_license(\"My Name\")\n#> ✓ Setting License field in DESCRIPTION to 'MIT + file LICENSE'\n#> ✓ Writing 'LICENSE.md'\n#> ✓ Adding '^LICENSE\\\\.md$' to '.Rbuildignore'\n#> ✓ Writing 'LICENSE'\n\nuse_package(\"MASS\", \"Suggests\")\n#> ✓ Adding 'MASS' to Suggests field in DESCRIPTION\n#> ● Use `requireNamespace(\"MASS\", quietly = TRUE)` to test if package is installed\n#> ● Then directly refer to functons like `MASS::fun()` (replacing `fun()`).\n\n# Set up other files -------------------------------------------------\nuse_readme_md()\n#> ✓ Writing 'README.md'\n\nuse_news_md()\n#> ✓ Writing 'NEWS.md'\n\nuse_test(\"my-test\")\n#> ✓ Adding 'testthat' to Suggests field in DESCRIPTION\n#> ✓ Creating 'tests/testthat/'\n#> ✓ Writing 'tests/testthat.R'\n#> ● Call `use_test()` to initialize a basic test file and open it for editing.\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#> ✓ Saving 'x', 'y' to 'data/x.rda', 'data/y.rda'\n#> ● Document your data (see 'https://r-pkgs.org/data.html')\n\n# Use git ------------------------------------------------------------\nuse_git()\n#> ✓ Initialising Git repo\n#> ✓ Adding '.Rhistory', '.RData', '.Rproj.user' 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":"1.6.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-04-29T08:30:11+0000"}}

Last chance! 50% off unlimited learning

Description

Usage

Arguments

See Also