rOpenSci | rOpenSci News Digest, March 2022

rOpenSci News Digest, March 2022

Dear rOpenSci friends, it’s time for our monthly news roundup!

You can read this post on our blog. Now let’s dive into the activity at and around rOpenSci!

🔗 rOpenSci HQ

The landing page for rOpenSci’s R-universe platform has gotten a makeover to facilitate easy searching through thousands of available R packages and articles. Discover new content by searching for keywords in package descriptions, authors, topics, vignettes, etc.

New R-universe landing page. There is a search bar. Below it are the logos of organizations. Above it is an animated rocket icon.

Give it a try at https://r-universe.dev!

🔗 Next coworking sessions

Join us for social coworking & office hours monthly on first Tuesdays! Hosted by Steffi LaZerte and various community hosts. Everyone welcome. No RSVP needed. Consult our Events page to find your local time and how to join.

Our next sessions are:

Find out about more events.

🔗 Software 📦

🔗 New packages

The following four packages recently became a part of our software suite:

  • commonmark, developed by Jeroen Ooms: The CommonMark specification defines a rationalized version of markdown syntax. This package uses the cmark reference implementation for converting markdown text into various formats including html, latex and groff man. In addition it exposes the markdown parse tree in xml format. Also includes opt-in support for GFM extensions including tables, autolinks, and strikethrough text. It is available on CRAN.

  • gendercoder, developed by Emily Kothe together with Jennifer Beaudry, Felix Singleton Thorn, Rhydwyn McGuire, Nicholas Tierney, and Mathew Ling: Provides functions and dictionaries for recoding of freetext gender responses into more consistent categories. It has been reviewed by Julia Silge, and Elin Waring.

  • occCite, developed by Hannah L. Owens together with Cory Merow, Brian Maitner, Jamie M. Kass, Vijay Barve, and Robert P. Guralnick: Facilitates the gathering of biodiversity occurrence data from disparate sources. Metadata is managed throughout the process to facilitate reporting and enhanced ability to repeat analyses. It is available on CRAN. It has been reviewed by Damiano Oldoni.

  • universe, developed by Jeroen Ooms: Utilities to interact with the R-universe platform. Includes functions to manage local package repositories, as well as API wrappers for retrieving data and metadata about packages in r-universe.

Discover more packages, read more about Software Peer Review.

🔗 New versions

The following ten packages have had an update since the last newsletter: commonmark (v1.8.0), biomartr (v1.0.2), git2r (v0.30.1), jqr (v1.2.3), nasapower (v4.0.6), occCite (v0.5.2), rsnps (v0.5.0), tarchetypes (0.5.0), targets (0.11.0), and tic (v0.12.0).

🔗 Software Peer Review

There are seventeen recently closed and active submissions and 4 submissions on hold. Issues are at different stages:

Find out more about Software Peer Review and how to get involved.

🔗 Use cases

One use case of our packages and resources has been reported since we sent the last newsletter.

Explore other use cases and report your own!

🔗 Call for maintainers

The rrricanes package is looking for a new maintainer! rrricanes is a web scraper for Atlantic and east Pacific hurricanes and tropical storms. See the corresponding GitHub issue.

You can refer to:

🔗 Package development corner

Some useful tips for R package developers. 👀

🔗 Get inspired by the tidyverse spring cleaning

The tidyverse packages have been undergoing spring cleaning helped by a public checklist that is worth a read (example in the tidymodels package repository). Some items are specific to tidyverse-affiliated packages, but not all of them. Others have equivalent e.g. you could run desc::desc_normalize() instead of usethis::use_tidy_description(). How many boxes could you already check, how many could you check in a short time for packages of yours? 😉

On a more meta level, the idea of checklists in issues like with usethis::use_release_issue() is quite neat and generalizable.

🔗 roxygen2 tips

One of the items in the aforementioned checklist is usethis::use_roxygen_md() for switching to use Markdown in roxygen2 docs. Much easier for adding bold text, code, etc.

Another good thing to know is that the roxygen2 pkgdown website has guidance on repeating yourself in your docs (“Every page is page one”! Or, as written in our packaging guide, “the principle of multiple points of entry i.e. to take into account the fact that any piece of documentation may be the first encounter the user has with the package and/or the tool/data it wraps.”). See also the blog post “Reuse Rmd fragments in package vignettes, README, blog posts and more” by Garrick Aden-Buie.

Lastly, do you know about katex by Jeroen Ooms for displaying math in R documentation?

🔗 Alternatives/complements to pkgdown for package docs?

Documentation websites for rOpenSci packages are happily built with pkgdown. However depending on your preferences or needs (e.g. what if you want to integrate the docs of your R packages with docs of other non R elements of your pipeline) you might like:

  • r2readthedocs by Mark Padgham to convert R package documentation to a ‘readthedocs’ website. It is used for documenting rOpenSci review tools.
  • altdoc by Etienne Bacher, that provides helper functions to use docute, docsify, and mkdocs.

🔗 Last words

Thanks for reading! If you want to get involved with rOpenSci, check out our Contributing Guide that can help direct you to the right place, whether you want to make code contributions, non-code contributions, or contribute in other ways like sharing use cases.

If you haven’t subscribed to our newsletter yet, you can do so via a form. Until it’s time for our next newsletter, you can keep in touch with us via our website and Twitter account.