updated

.github/CONTRIBUTING.md

@@ -1,59 +1,32 @@
-# CONTRIBUTING #
+# Contributing
 
-### Fixing typos
+Development is a community effort, and we welcome participation.
 
-Small typos or grammatical errors in documentation may be edited directly using
-the GitHub web interface, so long as the changes are made in the _source_ file.
+## Code of Conduct
 
-*  YES: you edit a roxygen comment in a `.R` file below `R/`.
-*  NO: you edit an `.Rd` file below `man/`.
+Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). 
 
-### Prerequisites
+## Issues
 
-Before you make a substantial pull request, you should always file an issue and
-make sure someone from the team agrees that it’s a problem. If you’ve found a
-bug, create an associated issue and illustrate the bug with a minimal 
-[reprex](https://www.tidyverse.org/help/#reprex).
+<https://github.com/ropensci/medrxivr/issues> is for maintenance tasks feature requests. When you post, please abide by the same guidelines as <https://books.ropensci.org/targets/help.html>.
 
-### Pull request process
+## Development
 
-*  We recommend that you create a Git branch for each pull request (PR).  
-*  Look at the Travis and AppVeyor build status before and after making changes.
-The `README` should contain badges for any continuous integration services used
-by the package.  
-*  We recommend the tidyverse [style guide](http://style.tidyverse.org).
-You can use the [styler](https://CRAN.R-project.org/package=styler) package to
-apply these styles, but please don't restyle code that has nothing to do with 
-your PR.  
-*  We use [roxygen2](https://cran.r-project.org/package=roxygen2).  
-*  We use [testthat](https://cran.r-project.org/package=testthat). Contributions
-with test cases included are easier to accept.  
-*  For user-facing changes, add a bullet to the top of `NEWS.md` below the
-current development version header describing the changes made followed by your
-GitHub username, and links to relevant issue(s)/PR(s).
+External code contributions are extremely helpful in the right circumstances. Here are the recommended steps.
 
-### Code of Conduct
+1. Prior to contribution, please propose your idea in a discussion thread so you and the maintainer can define the intent and scope of your work.
+2. [Fork the repository](https://help.github.com/articles/fork-a-repo/).
+3. Follow the [GitHub flow](https://guides.github.com/introduction/flow/index.html) to create a new branch, add commits, and open a pull request.
+4. Discuss your code with the maintainer in the pull request thread.
+5. If everything looks good, the maintainer will merge your code into the project.
 
-Please note that the medrxivr project is released with a
-[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
-project you agree to abide by its terms.
+Please also follow these additional guidelines.
 
-### See rOpenSci [contributing guide](https://devguide.ropensci.org/contributingguide.html)
-for further details.
-
-### Discussion forum
-
-Check out our [discussion forum](https://discuss.ropensci.org) if
-
-* you have a question, an use case, or otherwise not a bug or feature request for the software itself.
-* you think your issue requires a longer form discussion.
-
-### Prefer to Email? 
-
-Email the person listed as maintainer in the `DESCRIPTION` file of this repo.
-
-Though note that private discussions over email don't help others - of course email is totally warranted if it's a sensitive problem of any kind.
-
-### Thanks for contributing!
-
-This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md 
+* Respect the architecture and reasoning of the package. Depending on the scope of your work, you may want to read the design documents (package vignettes).
+* If possible, keep contributions small enough to easily review manually. It is okay to split up your work into multiple pull requests.
+* Format your code according to the [tidyverse style guide](https://style.tidyverse.org/) and check your formatting with the `lint_package()` function from the [`lintr`](https://github.com/jimhester/lintr) package.
+* For new features or functionality, add tests in `tests`. Tests that can be automated should go in `tests/testthat/`. Tests that cannot be automated should go in `tests/interactive/`. For features affecting performance, it is good practice to add profiling studies to `tests/performance/`.
+* Check code coverage with `covr::package_coverage()`. Automated tests should cover all the new or changed functionality in your pull request.
+* Run overall package checks with `devtools::check()` and `goodpractice::gp()`
+* Describe your contribution in the project's [`NEWS.md`](https://github.com/ropensci/targets/blob/main/NEWS.md) file. Be sure to mention relevent GitHub issue numbers and your GitHub name as done in existing news entries.
+* If you feel contribution is substantial enough for official author or contributor status, please add yourself to the `Authors@R` field of the [`DESCRIPTION`](https://github.com/ropensci/targets/blob/main/DESCRIPTION) file.

R/medrxivr-package.R

@@ -5,7 +5,7 @@
 #' Harbour Laboratory.It also provides functions to search the preprint data,
 #' export it to a .bib file, and download the PDFs associated with specified
 #' records.
-#' #' @keywords internal
+#' @keywords internal
 "_PACKAGE"
 globalVariables(c("doi"))
 

R/mx_syntax.R

@@ -1,7 +1,7 @@
-#' Search term wrapper that allows for different capitalisation of term
+#' Search term wrapper that allows for different capitalization of term
 #'
-#' @description Inspired by the varying capitalisation of "NCOV" during the
-#'   coronavirus pandemic (e.g. ncov, nCoV, NCOV, nCOV), this function allows
+#' @description Inspired by the varying capitalization of "NCOV" during the
+#'   corona virus pandemic (e.g. ncov, nCoV, NCOV, nCOV), this function allows
 #'   for all possible configurations of lower- and upper-case letters in your
 #'   search term.
 #'
@@ -23,8 +23,8 @@
 #'
 mx_caps <- function(x) {
 
-  x_v <- stringr::str_to_lower(x) %>%
-    stringr::str_split(stringr::boundary()) %>%
+  x_v <- stringr::str_to_lower(x) |>
+    stringr::str_split(stringr::boundary()) |>
     unlist()
 
   for (position in 1:nchar(x)) {