{"Package":"usethis","Title":"Automate Package and Project Setup","Version":"1.5.0","Authors@R":"c(\nperson(\"Hadley\", \"Wickham\", , \"hadley@rstudio.com\", role = \"aut\",\ncomment = c(ORCID = \"0000-0003-4757-117X\")\n),\nperson(\"Jennifer\", \"Bryan\", , \"jenny@rstudio.com\", c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0002-6983-2759\")\n),\nperson(\"RStudio\", 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', '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.1)","Imports":"clipr (>= 0.3.0), clisymbols, crayon, curl (>= 2.7), desc, fs\n(>= 1.2.0), gh, git2r (>= 0.23), glue (>= 1.2.0), purrr, rlang,\nrprojroot (>= 1.2), rstudioapi, stats, utils, whisker, withr,\nyaml","Suggests":"covr, knitr, magick, pkgdown (>= 1.1.0), rmarkdown, roxygen2,\nspelling (>= 1.2), styler (>= 1.0.2), testthat (>= 2.0.0)","Encoding":"UTF-8","Language":"en-US","LazyData":"true","RoxygenNote":"6.1.1","NeedsCompilation":"no","Packaged":"2019-04-05 19:31:44 UTC; jenny","Author":"Hadley Wickham [aut] (),\nJennifer Bryan [aut, cre] (),\nRStudio [cph, fnd]","Maintainer":"Jennifer Bryan ","Repository":"CRAN","Date/Publication":"2019-04-07 10:50:44 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/usethis_1.5.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[![Travis build\nstatus](https://travis-ci.org/r-lib/usethis.svg?branch=master)](https://travis-ci.org/r-lib/usethis)\n[![AppVeyor build\nstatus](https://ci.appveyor.com/api/projects/status/github/r-lib/usethis?branch=master&svg=true)](https://ci.appveyor.com/project/r-lib/usethis)\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/RtmplWepAV/mypkg/'\n#> ✔ Setting active project to '/private/tmp/RtmplWepAV/mypkg'\n#> ✔ Creating 'R/'\n#> ✔ Creating 'man/'\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#> * Hadley Wickham [aut, cre]\n#> * RStudio [cph]\n#> Description: What the package does (one paragraph).\n#> License: GPL-3\n#> Encoding: UTF-8\n#> LazyData: true\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/RtmplWepAV/mypkg/'\n#> ✔ Setting active project to '/private/tmp/RtmplWepAV/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 use `MASS::fun()` to refer to functions.\n\n# Set up various packages ---------------------------------------------\nuse_roxygen_md()\n#> ✔ Setting Roxygen field in DESCRIPTION to 'list(markdown = TRUE)'\n#> ✔ Setting RoxygenNote field in DESCRIPTION to '6.1.1'\n#> ● Run `devtools::document()`\n\nuse_rcpp()\n#> ✔ Creating 'src/'\n#> ✔ Adding '*.o', '*.so', '*.dll' to 'src/.gitignore'\n#> ● Copy and paste the following lines into '/private/tmp/RtmplWepAV/mypkg/R/mypkg-package.R':\n#> ## usethis namespace: start\n#> #' @useDynLib mypkg, .registration = TRUE\n#> ## usethis namespace: end\n#> NULL\n#> ✔ Adding 'Rcpp' to LinkingTo field in DESCRIPTION\n#> ✔ Adding 'Rcpp' to Imports field in DESCRIPTION\n#> ● Copy and paste the following lines into '/private/tmp/RtmplWepAV/mypkg/R/mypkg-package.R':\n#> ## usethis namespace: start\n#> #' @importFrom Rcpp sourceCpp\n#> ## usethis namespace: end\n#> NULL\n\nuse_revdep()\n#> ✔ Creating 'revdep/'\n#> ✔ Adding '^revdep$' to '.Rbuildignore'\n#> ✔ Adding 'checks', 'library', 'checks.noindex', 'library.noindex', 'data.sqlite', '*.html' to 'revdep/.gitignore'\n#> ✔ Writing 'revdep/email.yml'\n#> ● Run checks with `revdepcheck::revdep_check(num_workers = 4)`\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#> ✔ Writing 'tests/testthat/test-my-test.R'\n\nx <- 1\ny <- 2\nuse_data(x, y)\n#> ✔ Creating 'data/'\n#> ✔ Saving 'x', 'y' to 'data/x.rda', 'data/y.rda'\n\n# Use git ------------------------------------------------------------\nuse_git()\n#> ✔ Initialising Git repo\n#> ✔ Adding '.Rhistory', '.RData', '.Rproj.user' to '.gitignore'\n```\n\nPlease note that the usethis project is released with a [Contributor\nCode of Conduct](.github/CODE_OF_CONDUCT.md). By contributing to this\nproject, you agree to abide by its terms.","jobInfo":{"package":"usethis","version":"1.5.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2019-07-04T13:29:48+0000"}}

Description

Usage

Arguments

See Also