Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rOpenSci Preparation #15

Merged
merged 3 commits into from
Apr 1, 2021

Conversation

program--
Copy link
Contributor

@program-- program-- commented Mar 31, 2021

This pull request involves preparing AOI for submission to rOpenSci.

AOI version number is incremented to 0.2.0.9000 with this PR.

Additions/Modifications

  • Styled all functions to conform to tidyverse style guidelines, using styler::style_pkg().
  • Modified aoi_draw() to allow for file writing, and user input for object/file name.
  • Removed pkgdown build from repo.
  • Included codemeta.json as required for rOpenSci.
  • Included NEWS.md as required for rOpenSci.
  • Included GitHub Actions workflows for tidyverse-recommended R CMD Checks as required for rOpenSci.
    • macOS, R release
    • Windows, R release
    • Windows, R 3.6
    • Ubuntu 18.04, R devel
    • Ubuntu 18.04, R release
    • Ubuntu 18.04, R oldrel
    • Ubuntu 18.04, R 3.5
    • Ubuntu 18.04, R 3.4
    • Ubuntu 18.04, R 3.3
  • Included GitHub Actions workflow for pkgdown.
  • Included GitHub Actions workflow for test coverage.
  • Included GitHub Actions workflow for pull requests.
  • Included R CMD Check workflow badge in README.

Needs Solution

  • rOpenSci requires that shiny applications within a package have a testing framework (such as shinytest) for automated tests. shiny has a built-in test framework that derives from shinytest, but I'm not very familiar with it, and I couldn't get it to work with aoi_draw(). Since the shiny app is minimal, maybe we can get away with not worrying about this?

Local R CMD Check

── R CMD check results ────────────────────────────────────────────────── AOI 0.2.0.9000 ────
Duration: 35.2s

❯ checking R code for possible problems ... NOTE
  Found the following assignments to the global environment:
  File ‘AOI/R/aoi_draw.R’:
    assign(input$aoi_name, values$sf, envir = globalenv())

0 errors ✔ | 0 warnings ✔ | 1 note ✖

This note is required for aoi_draw() functionality 😄

Local Test Results

══ Results ══════════════════════════════════════════════════════════════════════════════════
Duration: 37.5 s

[ FAIL 0 | WARN 4 | SKIP 0 | PASS 92 ]

Warnings are due to: CRS object has comment, which is lost in output

@program-- program-- changed the title rOpenSci Review Preparation rOpenSci Preparation Mar 31, 2021
@mikejohnson51
Copy link
Owner

@program-- looks great! Can you remove the docs folder from the PR? Right now the 2018 changed files are a lot to go through :)

thanks!

@mikejohnson51 mikejohnson51 merged commit 421261e into mikejohnson51:master Apr 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants