Merge latest development in main - #8
Merged
Merged
Conversation
This reverts commit 3630d7e.
website now being buildt + deployed to gh-pages branch
Update R-CMD-check, pkgdown, and test-coverage workflows to match the current r-lib/actions v2 templates: slim R-CMD-check matrix to standard 5 jobs (macOS/Windows release + Ubuntu devel/release/oldrel-1), switch test-coverage to the cobertura + codecov-action v6 flow, bump actions/checkout to v6, and pin third-party actions by SHA.
Align .gitignore with the canonical GitHub R template (add .RDataTmp, .Ruserdata, R CMD build/check artefacts, .httr-oauth, knitr/rmarkdown caches, .Renviron, docs/, rsconnect/, revdep/, .DS_Store). Add .claude/, .DS_Store, air.toml, and LICENSE.md to .Rbuildignore; drop entries for the removed .lintr and full GPL-3 LICENSE file (R-exts discourages shipping yet another copy of the GNU COPYING file). Replace the lintr config with an air formatter config; ship a rendered LICENSE.md (excluded from the build tarball) so pkgdown can link to the full GPL-3 text.
DESCRIPTION:
* drop stale Date field and bump R minimum to 4.1 to match the
current testthat (3.3.2) requirement
* add Config/testthat/edition: 3 and Config/Needs/{coverage,website}
* add pkgdown site to URL
* add withr to Suggests; let roxygen2 8.x manage its own version field
R source:
* add package-level help page via R/fpCompare-package.R ("_PACKAGE")
* remove deprecated @doctype methods tag
* convert operator-table roxygen block to a markdown table
* factor out fp_tolerance() helper that supplies a default when
options(fpCompare.tolerance) is unset, making the operators robust
against accidental option clearing
* re-document; switch examples to ## for inline comments
* rename tests/test-all.R to tests/testthat.R (usethis convention) and
use the standard testthat preamble
* replace expect_true/expect_false with specific expectations for
better failure output
* add tests for vector recycling, NA/Inf propagation, custom tolerance
via withr::local_options(), and fallback when the option is unset
* drop the seed-dependent jitter-near-epsilon test in favour of a
deterministic tolerance-boundary test
* _pkgdown.yml: switch to HTTPS, drop pkgdown 1.x bootswatch syntax,
use template.bootstrap: 5
* README: HTTPS-only badges, fix R-CMD-check badge to the new
actions/workflows/*.yaml URL, recommend pak::pak() for GitHub
install, add a Code of Conduct reference
* vignette: fix "telorance" typo, switch install instructions to
pak::pak(), use ## for inline comments inside code blocks
* inst/CITATION: enables citation("fpCompare") via bibentry()
* .github/CODE_OF_CONDUCT.md: Contributor Covenant 2.1
* .github/CONTRIBUTING.md: tidyverse contributing guidelines
* NEWS.md: note R 4.1 minimum, tolerance fallback, and infrastructure
modernization
* cran-comments.md: refresh test environments and submission notes
Resolve conflicts:
* .Rbuildignore: combine modernization entries with main's CRAN
release artefact pattern. Drop obsolete CRAN-RELEASE pattern
(predates usethis 2.0).
* docs/: honour development's deletion of the vendored pkgdown site
(commit 915888d); pkgdown output is now generated by CI, not
committed.
* Drop stale CRAN-RELEASE (2019) and CRAN-SUBMISSION (v0.2.4) stubs
from main; usethis::submit_cran() will regenerate as needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Modernize
fpCompareagainst current best practices (r-pkgs.org, R-extensions manual, devtools/usethis conventions). Brings the packageonto testthat 3 + pkgdown 2, refreshes the GitHub Actions matrix, raises the minimum R version to 4.1 to match current dependency
requirements, and adds standard community files (CITATION, Code of Conduct, Contributing). Local
R CMD checkis clean (0 errors / 0warnings / 0 notes), CI is green across all 5 matrix jobs, and the current CRAN check page is OK across all 13 flavors. Version bumped to
0.2.6 for the next CRAN release.
Changes since master
CI & infrastructure
codecov/codecov-action@v6flowactions/checkoutto v6, pinned third-party actions by SHAubuntu-latest, updated workflows for Node 20Package metadata
Date:field; let roxygen2 8.x manage its own version fieldDepends: R (>= 3.6)→R (>= 4.1)to match the currenttestthatrequirementConfig/testthat/edition: 3,Config/Needs/coverage: covr,Config/Needs/website: pkgdownURL:field; addedwithrtoSuggestsR source
R/fpCompare-package.Rwith"_PACKAGE"sentinel)@docType methodstagfp_tolerance()helper that supplies a sensible default whenoptions(fpCompare.tolerance)is unset — operators staycorrect even if the option is cleared
Tests
tests/test-all.R→tests/testthat.R(usethis convention)expect_true/expect_falsewith specific expectations for better failure outputwithr::local_options(), and fallback when the option isunset
Docs
_pkgdown.yml: HTTPS, dropped pkgdown 1.xbootswatchsyntax,template.bootstrap: 5actions/workflows/*.yamlURL, switched install recommendation topak::pak(), added a Code of Conduct referencetelorancetypo, switched install instructions topak::pak()Community files
inst/CITATIONenablescitation("fpCompare").github/CODE_OF_CONDUCT.md(Contributor Covenant 2.1).github/CONTRIBUTING.md(tidyverse template)Housekeeping
.lintrwithair.toml(air formatter).gitignorewith GitHub's canonical R templateLICENSE.mdfor pkgdown only.Rbuildignore(add.claude/,.DS_Store,air.toml,LICENSE.md)vendored
docs/Test plan
R CMD check— 0 errors / 0 warnings / 0 notesdevtools::test()— 23/23 passingcitation("fpCompare")renders cleanlyNotes
cran-comments.mdhas been refreshed for the upcoming release.developmentbefore the modernization work began (R 3.4/3.5 drops, copyrightupdate, etc.) — these were never merged to master.