Want to share your content on R-bloggers? click here if you have a blog, or here if you don’t.
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
rOpenSci takes over maintenance of the {goodpractice} package
The {goodpractice} package was started by Gábor Csárdi in 2016 to auto-magically provide advice on good practices for your own R package.
rOpenSci’s Dev Guide has recommended using it from the first day we started writing it in 2018.
The package is now a central part of our own internal {pkgcheck} system, which is run automatically on all new submissions, and we recommend that all authors use our ‘pkgcheck-action’ GitHub action, which also runs {goodpractice}.
We are pleased to announce that rOpenSci has now taken over maintenance of the {goodpractice} package, thanks to the approval both of the original author Gábor, and the previous maintainers at ascent.io.
The package has now been moved to our ropensci-review-tools GitHub organization, which holds all software used in our automated checking system.
This also means that documentation for the package is now built by our own documentation system, and will live from here on at docs.ropensci.org/goodpractice/.
rOpenSci at CZI Open Science 2024
From June 10 to June 14 Noam Ross, Mauro Lepore and Yanina Bellini Saibene participated on the CZI Open Science 2024 event.
On Wednesday, we showcased the Champions Program, sharing Champions’ projects, training materials, and the results of the two-year pilot. We had the chance to chat and learn about many other projects during these sessions.
Yanina participated in the closing panel on Case Study Session 3: Demonstrating Impact of Open Science to explore the challenges of using traditional academic metrics to measure project impact and emphasize alternative approaches. In her talk, Yani introduced the work done by different rOpenSci members, the tools and metrics we use to capture their stories, and the impact we achieve together.
The rOpenSci community at upcoming events
Meet rOpenSci team and community members at events in the near future!
-
Two talks by rOpenSci team members, and more contributions by rOpenSci community members, to look forward to at useR! 2024 in Salzburg, Austria.
- Maëlle Salmon’s keynote talk “How your code might get rusty” on Wednesday, July 10 at 09:20 CEST;
- Jeroen Ooms’ talk “Navigating the R Ecosystem Using R-Universe” on Thursday, July 11, 11:30 – 11:50 CEST.
- Jon Harmon’s virtual talk “Learning Together at the Data Science Learning Community” will go live on the useR!2024 YouTube playlist at 10:30am CDT on July 2;
- Paola Corrales’ and Elio Campitelli’s tutorial “Efficient Data Analysis with data.table” on Monday, July 3 (pre-registration required);
- Elio Campitelli’s talk “Building Bilingual Bridges with Multilingual Manuals” on Tuesday, July 4 at 11:40 CEST.
- Hugo Gruson’s talk ”
Building Interoperability in Existing Software Ecosystems with S3 Classes” on Tuesday, July 9 at 14:50, and his poster “A reproducible analysis of CRAN Task Views to understand the state of an R package ecosystem” - Lluís Revilla’s and Henrik Bengtsson’s poster about CRAN packages archived and a the cranhaven.org R-universe created to reduce the impact of that on users.
- Will Landau’s and Charlie Gao’s talk “Moju-Kapu: How {Mirai} and {Crew} Are Powering the Next Generation of Parallel Computing in R” on Tuesday, July 9 at 11:00 CEST.
- Binod Jung Bogati’s talks “Generate Raw Synthetic Dataset for Clinical Trial – Binod Jung Bogati, Numeric Mind” on Tuesday, July 9 at 13:30 CEST; and “Translate R for Global Reach” on Thursday, July 11 at 12:10 CEST.
-
At posit::conf(2024) in Seattle, US, you’ll get to meet some champions and mentors!
- Look for: Andrea Gomez Vargas; Yi-Chin Sunny Tseng; Luis D. Verde Arregoitia; Francisco Cardozo; Jonathan Keane.
- Don’t miss Luis’ lightning talk “Why’d you load that package for?” on Tuesday, Aug 13 at 1:00 PM PDT
-
We’re excited to share that rOpenSci community manager Yanina Bellini Saibene will deliver a keynote talk at BioNT Community Event & CarpentryConnect-Heidelberg 2024, on November 14th in Heidelberg, Germany.
Coworking
Read all about coworking!
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.
-
Tuesday, July 2nd, 14:00 Europe Central (12:00 UTC), Git and GitHub with cohost Zhian Kamvar and Steffi LaZerte.
- Read up on Git and GitHub and how they might serve you
- Start your first Git/GitHub project
- Chat with our cohost about the pros and cons of Git & GitHub, resources for getting started and tips and tricks.
-
Tuesday, August 6th, 9:00 America Pacific (16:00 UTC), Building your first R package with cohost Carolina Pradier and Steffi LaZerte.
- Explore how to make R packages
- Plan out that package you’ve always wanted to create
- Chat with our cohost about tips and tricks for making your first R package
And remember, you can always cowork independently on work related to R, work on packages that tend to be neglected, or work on what ever you need to get done!
Software
New packages
The following three packages recently became a part of our software suite:
-
goodpractice, developed by Mark Padgham together with Karina Marks, Daniel de Bortoli, Gabor Csardi, Hannah Frick, Owen Jones, and Hannah Alexander: Give advice about good practices when building R packages. Advice includes functions and syntax to avoid, package structure, code complexity, code formatting, etc. It is available on CRAN.
-
mregions2, developed by Salvador Fernandez-Bejarano together with Lotte Pohl: Explore and retrieve marine geo-spatial data from the Marine Regions Gazetteer and the Marine Regions Data Products, including the Maritime Boundaries. It has been reviewed.
-
rOPTRAM, developed by Micha Silver: The OPtical TRapezoid Model (OPTRAM) derives soil moisture based on the linear relation between a vegetation index and Land Surface Temperature (LST). The Short Wave Infra-red (SWIR) band is used as a proxy for LST. See: Sadeghi, M. et al., 2017. https://doi.org/10.1016/j.rse.2017.05.041 .
Discover more packages, read more about Software Peer Review.
New versions
The following nine packages have had an update since the last newsletter: goodpractice (v1.0.5
), beastier (v2.5.1
), c14bazAAR (5.0.0
), comtradr (v1.0.1
), DataPackageR (v0.16.0
), dynamite (1.5.2
), readODS (v2.3.0
), rgbif (v3.8.0
), and targets (1.7.1
).
Software Peer Review
There are fourteen recently closed and active submissions and 6 submissions on hold. Issues are at different stages:
-
Three at ‘6/approved’:
-
karel, Learning programming with Karel the robot. Submitted by Marcos Prunello.
-
rOPTRAM, Derive soil moisture using the OPTRAM algorithm. Submitted by Micha Silver.
-
mregions2, Access Data from Marineregions.org: The Marine Regions Gazetteer and the Marine Regions Data Products. Submitted by salvafern.
-
-
Four at ‘4/review(s)-in-awaiting-changes’:
-
cancerprof, API Client for State Cancer Profiles. Submitted by Brian Park.
-
osmapiR, OpenStreetMap API. Submitted by Joan Maspons.
-
rix, Rix: Reproducible Environments with Nix. Submitted by Bruno Rodrigues.
-
agromet, Índices y Estadísticos Climáticos e Hidrológicos. Submitted by Paola Corrales.
-
-
Five at ‘3/reviewer(s)-assigned’:
-
eDNAjoint, Joint Modeling of Traditional and Environmental DNA Survey Data. Submitted by Abigail Keller.
-
chopin, CHOPIN: Computation for Climate and Health research On Parallelized INfrastructure. Submitted by Insang Song.
-
rsi, Efficiently Retrieve and Process Satellite Imagery. Submitted by Michael Mahoney.
-
sits, Satellite Image Time Series Analysis for Earth Observation Data Cubes. Submitted by Gilberto Camara.
-
fwildclusterboot, Fast Wild Cluster Bootstrap Inference for Linear Models. Submitted by Alexander Fischer. (Stats).
-
-
One at ‘2/seeking-reviewer(s)’:
- QuadratiK, A Collection of Methods Using Kernel-Based Quadratic Distances for. Submitted by Giovanni Saraceno. (Stats).
-
One at ‘1/editor-checks’:
- gigs, Assess Fetal, Newborn, and Child Growth with International Standards. Submitted by Simon Parker. (Stats).
Find out more about Software Peer Review and how to get involved.
On the blog
Software Review
- From scripts to package. Developing dendroNetwork and learning with rOpenSci by Ronald Visser. How scripts were transformed into a package and what I learned in the process.
Tech Notes
- A fresh new look for R-universe! by Jeroen Ooms. We have given the WebUI for R-universe a big refresh. This is the biggest UX overhaul in since the beginning of the project.
Calls for contributions
Calls for maintainers
If you’re interested in maintaining any of the R packages below, you might enjoy reading our blog post What Does It Mean to Maintain a Package?.
-
historydata, datasets for historians. Issue for volunteering.
-
USAboundaries (and USAboundariesdata), historical and contemporary boundaries of the United States of America . Issue for volunteering.
Calls for contributions
Also refer to our help wanted page – before opening a PR, we recommend asking in the issue whether help is still needed.
Package development corner
Some useful tips for R package developers.
Make your functions compa-tibble
Do the functions of your package use data.frame
as input?
Do not miss Hugo Gruson’s post Make your functions compa-tibble as users of your package might well try and pass a tibble
, which you probably don’t want to be a showstopper!
Use lintr to enforce your package’s function preferences
Do you want to commit to using the cli package instead of base R messaging?
You can configure the lintr settings for your codebase to pick up usage of certain functions, to inform you along with the preferred replacement.
See, as an example, pkgdown’s lintr configuration file and the corresponding GitHub Actions workflow (from r-lib/actions).
This neat safeguard makes use of the Undesirable function linter.
More metadata on CRAN
CRAN pages of packages now show…
-
Issues which need fixing! Shared by Henrik Bengtsson.
-
DOIs! Have you seen Achim Zeileis’ announcement that All R packages on CRAN will get an official DOI?
In contrast to Zenodo DOIs, it’s the same DOI across all versions.
A pure GitHub preview workflow for pkgdown websites
If you use a gh-pages branch on GitHub to store the source of your pkgdown website, and use GitHub Pages to deploy it, you could extend that workflow to create (and then clean) subdirectories in that branch to host previews of pull requests.
Check out this GitHub Actions workflow file by Garrick Aden-Buie.
Tips for refactoring test files
Do you put the object as close as possible to the related expectation(s)?
Read about this, and other, tips for refactoring test files.
One more tool for checking inputs of your R functions
Do you check inputs of your R functions?
Beside the aforelinked R-hub blog post by Hugo Gruson, Sam Abbott, Carl Pearson, you might be interested in the experimental stbl package by Jon Harmon.
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.
You can also support our work through donations.
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 Mastodon account.
R-bloggers.com offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you’re looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don’t.
Continue reading: rOpenSci News Digest, June 2024
Understanding the Role and Continued Expansion of the rOpenSci Project
rOpenSci, an initiative for open source tools serving the scientific community continues to gain momentum, expand and contribute to broad-reaching projects and events in the field of open science. By analyzing recent developments and future endeavors, we can anticipate the long-term implications of its growth and formulate advice for those wishing to contribute or utilise its resources.
Open Source Package Maintenance
Key to rOpenSci’s contribution to the open source community is the stewardship of packages, the most recent being the {goodpractice} package. This package offers advice on the best practices for building R packages. Its maintenance by rOpenSci, following approval from the original author and previous maintainers, solidifies the package’s place in rOpenSci’s internal {pkgcheck} system, used to automatically run checks on new submissions.
The implications of assuming this responsibility extend beyond the improvement of the package itself. When an influential organisation like rOpenSci maintains important packages, it can set a standard of quality and ensure continual updates and improvements. This, in turn, assures users of the package’s reliability and longevity, which encourages usage and contribution from the community.
Actionable Advice:
- For existing users of the {goodpractice} package, continue your usage and consider contributing to its development where possible.
- If you’re not yet using the package, consider integrating it into your workflow for more efficient package building.
- Stay informed about the major events that rOpenSci is participating in to follow important discussions and developments.
- Learn from the resources and information shared at these events.
- Consider how you can contribute to the discourse or use the knowledge shared to improve your own open science practices.
- Keep an eye on the schedule of upcoming events involving rOpenSci and decide which to attend based on your areas of interest.
- Take the opportunity to meet team members, share your thoughts, and collaborate on projects of mutual interest that can help to further expand the open science community.
- Even if not a professional developer, consider reviewing and contributing to the packages that interest you. This not only improves the tool but also develops your own professional skills.
- The call for contributions should not only be seen as a responsibility but also an excellent opportunity for learning and professional growth.
- If you’re a package developer, ensure your functions are compatible with tibble and data.frame formats.
- Be proactive in seeking out and applying advice from the community, especially if it enhances the usability of your package.
rOpenSci’s Impact on Major Events
rOpenSci made a significant impact at the recent CZI Open Science 2024 event where several panel discussions and sessions were organized. The Champions Program, which showcases project results and training materials from open science proponents, was centre stage. Impact measurement techniques in open science, particularly alternatives to traditional academic metrics, were also a point of discussion.
Through participation in such major events, rOpenSci not only highlights its own initiatives but also contributes to a wider discourse on open science. Discussing impact measurement, for example, helps to shape future assessment frameworks and validates the work being done outside of academia. Sharing learning materials and project highlights raises awareness and shares knowledge, both of which foster the growth of the open science community.
Actionable Advice:
Upcoming rOpenSci Involvement
The global footprint of rOpenSci is set to expand with its members participating in numerous upcoming events, hosting technical discussions, informative talks, and tutorials. These include contributions to useR! 2024, posit::conf(2024), and CarpentryConnect-Heidelberg 2024, among others.
Participation in diverse, global events demonstrates the growing influence and relevance of rOpenSci within the open science community. Such contributions not only extend the group’s impact but also provide opportunities for members of the community to learn and collaborate.
Actionable Advice:
Incorporating Peer Review and Call for Contributions
rOpenSci’s power is in its community, as demonstrated by the continuous calls for peer review and the maintenance and improvement of diverse packages.
Inviting community contribution reinforces the collaborative philosophy of open source, encouraging sharing and improving the quality, reliability, and functionality of tools.
Actionable Advice:
Promoting Good Practice
rOpenSci also offers resources and advice for package developers to help them improve their work’s efficiency and quality; for instance, it is recommended to make functions compatible with both data.frame and tibble.
Such advice helps to standardize open source contribution and make it easier for users to gain the maximum benefit from the resources available.
Actionable Advice:
rOpenSci is a community dedicated to open tools for open science, and their work significantly impacts the open science and open source landscape. By staying connected with rOpenSci’s activities, aspiring developers and science enthusiasts can contribute to and benefit from the community. Whether by extending the reach of relevant tools, participating in events, or involving themselves in peer review, prospective contributors are encouraged to be part of the growth and promotion of open science.