### R Package Description File Example Source: https://context7.com/ropensci/software-review/llms.txt This is an example of an R package DESCRIPTION file, typically included within a submission template. It contains metadata such as package name, title, version, authors, description, and license. ```r Package: mypackage Title: Retrieve Data from Example API Version: 1.0.0 Authors@R: person("Jane", "Smith", email = "jane@example.com", role = c("aut", "cre")) Description: Provides functions to retrieve and process data from the Example API. License: MIT + file LICENSE ``` -------------------------------- ### Install rOpenSci Package from R-Universe Source: https://context7.com/ropensci/software-review/llms.txt Use this R command to install reviewed packages from the rOpenSci R-Universe repository. ```r # Install an rOpenSci-reviewed package from R-Universe install.packages( "mypackage", repos = c( 'https://ropensci.r-universe.dev', 'https://cloud.r-project.org' ) ) # The R-Universe repository provides: # - Binary packages for faster installation # - Development versions between CRAN releases # - Automatic builds from the package repository ``` -------------------------------- ### R Package Description File for Statistical Package Source: https://context7.com/ropensci/software-review/llms.txt An example DESCRIPTION file for a statistical R package, used in pre-submission inquiries. It outlines the package title, version, description, and license. ```r Package: statpkg Title: Bayesian Time Series Analysis Version: 0.5.0 Description: Implements Bayesian methods for time series forecasting. License: GPL-3 ``` -------------------------------- ### Repository Transfer Checklist Source: https://context7.com/ropensci/software-review/llms.txt A markdown-formatted checklist for authors transferring their repository to the rOpenSci GitHub organization. ```markdown ## Repository Transfer Checklist 1. Transfer the repo to rOpenSci's "ropensci" GitHub organization under "Settings" - Requires two-factor authentication enabled 2. After transfer, comment on the review issue: @ropensci-review-bot finalize transfer of mypackage 3. Update all repository links: - Fix GitHub repo URLs in DESCRIPTION - Update CI badge URLs - Update coverage badge URLs 4. Update DESCRIPTION URL field: URL: https://docs.ropensci.org/mypackage, https://github.com/ropensci/mypackage 5. Remove custom Code of Conduct (rOpenSci's default applies) 6. For pkgdown websites, either: - Rely on rOpenSci central docs building at docs.ropensci.org/package_name - Or maintain your own with redirect from old URL ``` -------------------------------- ### Configure GitHub Actions for README Rendering Source: https://context7.com/ropensci/software-review/llms.txt A YAML workflow configuration for rendering R Markdown files and committing the results back to the repository. ```yaml on: workflow_dispatch: push: branches: - main paths: - README.Rmd - .github/workflows/main.yml schedule: - cron: '0 12 * * *' name: Render README jobs: render: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} name: Render README runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Prepare repository run: git checkout "${GITHUB_REF:11}" - uses: r-lib/actions/setup-pandoc@v2 - uses: r-lib/actions/setup-r@v2 - uses: r-lib/actions/setup-r-dependencies@v2 with: cache-version: 5 - name: Render README run: | rmarkdown::render("README.Rmd", output_format = "github_document") rmarkdown::render("README.es.Rmd", output_format = "github_document") shell: Rscript {0} env: AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }} AIRTABLE_ID: ${{ secrets.AIRTABLE_ID }} - name: Commit results run: | git config user.name "Github Actions" git config user.email "github-actions@github.com" git commit README.md README.es.md -m 'Re-build README.Rmd' || echo "No changes to commit" git push origin HEAD:${{ github.ref }} ``` -------------------------------- ### Statistical Software Submission Template Source: https://context7.com/ropensci/software-review/llms.txt Use this Markdown template to initiate a formal submission for statistical software review. ```markdown --- name: Submit statistical software for review about: Use this template to submit statistical software for review --- Submitting Author Name: Alice Chen Submitting Author Github Handle: @alicechen Repository: https://github.com/alicechen/mlpkg Version submitted: 2.0.0 Submission type: Stats Badge grade: silver Editor: TBD Reviewers: TBD Archive: TBD Version accepted: TBD Language: en --- ## Scope **Statistical Packages** - [x] Machine Learning - [x] Regression and Supervised Learning ## Pre-submission Inquiry - [x] A pre-submission inquiry has been approved in issue#456 ## General Information - Target audience: Machine learning practitioners and researchers - This is an improvement on other implementations of similar algorithms in R, offering better performance and more flexible model specification compared to existing packages. ## Badging - Badge grade: Silver - Aspects fulfilled: (1) Novel statistical methodology with peer-reviewed publication, (2) Comprehensive documentation with mathematical specification of all algorithms ## Technical checks - [x] I have read the rOpenSci packaging guide. - [x] I have read the Statistical Software Peer Review Guide for Authors. - [x] I/we have run autotest checks on the package. - [x] The srr_stats_pre_submit() function confirms this package may be submitted. - [x] The pkgcheck() function confirms this package may be submitted. ``` -------------------------------- ### Pre-submission Inquiry Template Source: https://context7.com/ropensci/software-review/llms.txt Use this markdown template for a pre-submission inquiry to verify if your package fits rOpenSci's scope, especially for statistical packages or when scope is uncertain. It includes author and repository details. ```markdown --- name: Submit a presubmission inquiry about: Not sure your software fits? Use this template for a quick response from editors --- Submitting Author Name: John Doe Submitting Author Github Handle: @johndoe Repository: https://github.com/johndoe/statpkg Submission type: Pre-submission Language: en --- - Paste the full DESCRIPTION file inside a code block below: ```r Package: statpkg Title: Bayesian Time Series Analysis Version: 0.5.0 Description: Implements Bayesian methods for time series forecasting. License: GPL-3 ``` ## Scope **Data Lifecycle Packages** - [ ] data retrieval **Statistical Packages** - [x] Bayesian and Monte Carlo Routines - [x] Time Series Analyses - Explain how the package falls under these categories: This package implements novel MCMC algorithms for time series forecasting with Bayesian inference. - If submitting a statistical package, have you incorporated documentation via the srr package? Yes, standards documentation is included via srr_stats tags. - Who is the target audience? Statisticians and data scientists working with time series data. - Any other questions? We are unsure if our novel algorithm implementation meets the criteria for statistical software review. ``` -------------------------------- ### Standard Software Submission Template Source: https://context7.com/ropensci/software-review/llms.txt Use this markdown template to initiate a standard peer review for data lifecycle R packages. It captures author details, repository information, package version, and submission type. ```markdown --- name: Submit software for review about: Use this template to submit software for review --- Submitting Author Name: Jane Smith Submitting Author Github Handle: @janesmith Other Package Authors Github handles: @coauthor1 Repository: https://github.com/janesmith/mypackage Version submitted: 1.0.0 Submission type: Standard Editor: TBD Reviewers: TBD Archive: TBD Version accepted: TBD Language: en --- - Paste the full DESCRIPTION file inside a code block below: ```r Package: mypackage Title: Retrieve Data from Example API Version: 1.0.0 Authors@R: person("Jane", "Smith", email = "jane@example.com", role = c("aut", "cre")) Description: Provides functions to retrieve and process data from the Example API. License: MIT + file LICENSE ``` ## Scope - Please indicate which category or categories this package falls under: - [x] data retrieval - [ ] data extraction - [ ] data munging - Explain how the package falls under these categories: This package retrieves biodiversity occurrence data from the Example API. - Who is the target audience? Ecologists and conservation researchers who need programmatic access to occurrence records. ## Technical checks - [x] I have read the rOpenSci packaging guide. - [x] I have read the author guide and expect to maintain this package for at least 2 years. This package: - [x] does not violate the Terms of Service of any service it interacts with. - [x] has a CRAN and OSI accepted license. - [x] contains a README with instructions for installing the development version. - [x] includes documentation with examples for all functions. - [x] contains a vignette with examples of its essential functions. - [x] has a test suite. - [x] has continuous integration, including reporting of test coverage. ## Code of conduct - [x] I agree to abide by rOpenSci's Code of Conduct. ``` -------------------------------- ### Add rOpenSci Review Badge Source: https://context7.com/ropensci/software-review/llms.txt Include this Markdown snippet in your package README.md to display the current review status. ```markdown # In your package README.md, add: [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/123_status.svg)](https://github.com/ropensci/software-review/issues/123) # Replace 123 with your actual issue number ``` -------------------------------- ### Review Management Bot Commands Source: https://context7.com/ropensci/software-review/llms.txt Commands for the Buffy bot to manage repository transfers and automated review notifications. ```markdown # Invite author to transfer repository (after approval) @ropensci-review-bot invite me to ropensci/mypackage # Finalize repository transfer and restore admin access @ropensci-review-bot finalize transfer of mypackage # The bot automatically posts welcome messages using templates: # Welcome {{sender}}, thanks for opening this issue :tada: # Reviewer reminder template (automated): # :calendar: {{reviewer}} you have {{days_before_deadline}} days left before the due date for your review ({{due_date}}). ``` -------------------------------- ### Query Airtable for Reviewer Data Source: https://context7.com/ropensci/software-review/llms.txt R script to fetch and process reviewer and editor information from Airtable for administrative use. ```r # Setup environment variables Sys.setenv(AIRTABLE_API_KEY = "your_api_key") Sys.setenv(AIRTABLE_ID = "your_base_id") # Fetch all reviewers from Airtable library(airtabler) at_rev <- airtabler::airtable( base = Sys.getenv("AIRTABLE_ID"), table = "reviewers-prod" ) reviewers <- at_rev$`reviewers-prod`$select_all() # Get current Editor-in-Chief at_eic <- airtabler::airtable( base = Sys.getenv("AIRTABLE_ID"), table = "editor-in-chief-rotation" ) eic <- at_eic$`editor-in-chief-rotation`$select_all() # Find current EiC based on date eic$period_start <- as.Date(eic$period_start) eic$period_end <- as.Date(eic$period_end) today <- Sys.Date() eic_now <- eic[which(eic$period_start <= today & eic$period_end >= today), ] eic_name <- eic_now$acting_eic_name[[1]] # Get active editors (excluding EiC and emeritus) editor_index_all <- purrr::map_lgl(reviewers$editor, ~!is.null(.)) editors_all <- reviewers[which(editor_index_all), c("name", "github", "Affiliation", "editor")] editors_all <- editors_all[which(!editors_all$name == eic_name), ] # Sort by last name last_names <- humaniformat::last_name(trimws(editors_all$name)) editors <- editors_all[order(last_names), ] # Filter out emeritus editors editors_past <- editors_all[grep("Emeritus", editors_all$editor), ] editors <- editors_all[which(!editors_all$name %in% editors_past$name), ] ``` -------------------------------- ### Skip long-running tests on CRAN Source: https://github.com/ropensci/software-review/wiki/CRAN-gotchas Use this function within testthat files to prevent tests from running on CRAN infrastructure while maintaining local and CI execution. ```R testthat::skip_on_cran ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.