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

Release version 1.0.0 #227

Merged
merged 33 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
eeb33f5
Pushing develop branch
fontikar Apr 18, 2024
166a51e
Small fixes (#193)
ehwenk Apr 18, 2024
c68dc70
Add testing for functions: standardise_names, strip_names, extract_genus
dfalster Apr 19, 2024
47729b9
Rename testing files to alter order of tests (slow results last)
dfalster Apr 19, 2024
2a8fedb
Activate tests on develop branch
dfalster Apr 19, 2024
24e126e
Refactor load_taxonomic_resources to increase speed (#196)
dfalster Apr 19, 2024
a82ea31
Update doc (#192)
fontikar Apr 22, 2024
3cf5388
108 make output messages optional and reanimate caching
wcornwell Apr 23, 2024
f2e5b38
Standardise names updates (#200)
ehwenk Apr 23, 2024
e4da0ba
Removing hard limit on current downloads and documentation wording im…
wcornwell Apr 26, 2024
c272c2d
Message updates (#201)
ehwenk Apr 28, 2024
acc5eb0
updating github actions
wcornwell Apr 29, 2024
b4b13de
Rename/delete test files
dfalster Apr 29, 2024
0cc6663
Make messages to console optional
dfalster Apr 30, 2024
3d409bc
better family-level matching algorithms (#202)
ehwenk Apr 30, 2024
6b5e46a
Updated pkgdown and fixed error #205 (#206)
fontikar Apr 30, 2024
cd4b3e5
Added skip if github is down (#211)
fontikar Apr 30, 2024
6f630f6
Fuzzy-match: subset accepted list to same first letter (#210)
ehwenk Apr 30, 2024
ad7de34
Allow n_allowed > 1 in fuzzy_match (#213)
ehwenk Apr 30, 2024
06fe708
Identifier string fix (#214)
ehwenk May 1, 2024
a8c7632
Switch adist to stringdist (#216)
ehwenk May 1, 2024
d6f4a6e
Option if fuzzy_match accepted list is empty for a given letter (#218)
ehwenk May 1, 2024
9733c70
Add fuzzy match arguments to `create_taxonomic_update_lookup` (#219)
ehwenk May 1, 2024
9be9776
Apply our faster implementation of word throughout (#220)
dfalster May 1, 2024
e0e9086
removing unused function option and updating readme (#208)
wcornwell May 2, 2024
0ffe4fb
better description of `imprecise_fuzzy_matches` (#221)
ehwenk May 2, 2024
2cd65dc
cleaning up the namespace (#223)
wcornwell May 2, 2024
b785d3e
Remove dependency on forcats
dfalster May 2, 2024
10e909b
Remove use of .data in tidyselect (as deprecated)
dfalster May 2, 2024
1bf0761
Add line breaks (#224)
ehwenk May 3, 2024
96b8267
Update roxygen & websites (#225)
ehwenk May 5, 2024
41b4a78
Prepare for release: Bump version number, update news
dfalster May 6, 2024
809b11c
Fix typo
dfalster May 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
branches: [main, master, develop]
pull_request:
branches: [main, master, develop]

Expand All @@ -18,17 +18,16 @@ jobs:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

Expand All @@ -45,4 +44,5 @@ jobs:

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
upload-snapshots: true
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
2 changes: 1 addition & 1 deletion .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

Expand Down
27 changes: 23 additions & 4 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
branches: [main, master, develop]
pull_request:
branches: [main, master]
branches: [main, master, develop]

name: test-coverage

Expand All @@ -15,7 +15,7 @@ jobs:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-r@v2
with:
Expand All @@ -27,5 +27,24 @@ jobs:
needs: coverage

- name: Test coverage
run: covr::codecov(quiet = FALSE)
run: |
covr::codecov(
quiet = FALSE,
clean = FALSE,
install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
)
shell: Rscript {0}

- name: Show testthat output
if: always()
run: |
## --------------------------------------------------------------------
find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload test results
if: failure()
uses: actions/upload-artifact@v4
with:
name: coverage-test-failures
path: ${{ runner.temp }}/package
8 changes: 3 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: APCalign
Title: Resolving Plant Taxon Names Using the Australian Plant Census
Version: 0.1.4
Version: 1.0.0
Authors@R: c(
person(given = "Daniel", family = "Falster", role = c("aut", "cre", "cph"), email = "[email protected]", comment = c(ORCID = "0000-0002-9814-092X")),
person(given = "Elizabeth", family = "Wenk", role = c("aut", "ctb"), email = "[email protected]", comment = c(ORCID = "0000-0001-5640-5910")),
Expand All @@ -18,11 +18,10 @@ Depends:
Imports:
readr,
purrr,
forcats,
tibble,
dplyr,
stringr,
stringi,
stringdist,
crayon,
httr,
jsonlite,
Expand All @@ -38,9 +37,8 @@ Suggests:
kableExtra,
here,
testthat (>= 3.0.0)
Remotes: apache/arrow/r
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
Config/testthat/edition: 3
VignetteBuilder: knitr
URL: https://traitecoevo.github.io/APCalign/, https://github.com/traitecoevo/APCalign
Expand Down
18 changes: 4 additions & 14 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,13 @@
export(align_taxa)
export(create_species_state_origin_matrix)
export(create_taxonomic_update_lookup)
export(default_version)
export(load_taxonomic_resources)
export(native_anywhere_in_australia)
export(standardise_names)
export(standardise_taxon_rank)
export(state_diversity_counts)
export(strip_names)
export(strip_names_2)
export(strip_names_extra)
export(update_taxonomy)
import(dplyr)
import(stringr)
importFrom(crayon,red)
importFrom(dplyr,arrange)
importFrom(dplyr,distinct)
importFrom(dplyr,filter)
importFrom(dplyr,mutate)
importFrom(dplyr,select)
importFrom(readr,col_character)
importFrom(readr,col_logical)
importFrom(readr,cols)
importFrom(readr,read_csv)
importFrom(tibble,tibble)
importFrom(dplyr,"%>%")
34 changes: 31 additions & 3 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,37 @@
# APCalign 0.1.4
# APCalign 1.0.0

First major release of APCalign. A preprint is available at
https://www.biorxiv.org/content/10.1101/2024.02.02.578715v1.
Article has been accepted for publication at Australian journal of Botany.

* Better handling of errors when API/network connection is down for `load_taxonomic_resources`
Following review, a number of changes have been implemented. These have sped &
streamlined the package.

* Refined testing for `load_taxonomic_resources`
* Update function documentation
* Speed up `extract_genus`
* Write a replacement function for `stringr::word` that is much faster.
* Addional speed up `fuzzy_match` function by
- restricting reference list to names with the same first letter as input string.
- Switch from using `util:dist` to `stringdist:stringdist(method = "dl")`
* Rework `standardise_names` to remove punctuation from the start of the string
* Rework `strip_names_extra` (previously `strip_names_2`) to just perform
additional functions to `strip_names`, rather than repeating those performed by `strip_names`.
* Avoid importing entire packages by using package::function format throughout
and removing functions from @import
* Add fuzzy match arguments to `create_taxonomic_update_lookup`
* Add 3 additional family-level APC matches to `match_taxa`.
* Refine tests
* Make messages to console optional
* Fix issue with fails when github is down (https://github.com/traitecoevo/APCalign/issues/205)

# APCalign 0.1.5


* Update installation instructions
* Added how to cite and version APCalign as an article
* Exported `default_version`
* Add citing method for R package
* Update GitHub Actions
* Improved family alignments
* Added `standardise_taxon_rank`
* Improved messaging during alignment
8 changes: 7 additions & 1 deletion R/APCalign-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
#' @name APCalign
#' @docType package
#' @references If you have any questions, comments or suggestions, please
#' submit an issue at our [GitHub repository](https://github.com/traitecoevo/APCalign/issues)
#' submit an issue at our
#' [GitHub repository](https://github.com/traitecoevo/APCalign/issues)
#' @keywords internal
#' @section Functions:
#' **Standarise taxon names**
Expand Down Expand Up @@ -51,9 +52,12 @@ utils::globalVariables(
"checked",
"cleaned_name",
"family",
"family_accepted",
"fuzzy_match_genus",
"fuzzy_match_genus_APNI",
"fuzzy_match_genus_synonym",
"fuzzy_match_family",
"fuzzy_match_family_synonym",
"genus",
"genus_accepted",
"known",
Expand All @@ -75,6 +79,8 @@ utils::globalVariables(
"taxon_ID",
"taxon_ID_aligned",
"taxon_rank",
"txtProgressBar",
"setTxtProgressBar",
"taxonomic_status",
"taxonomic_status_aligned",
"taxonomic_status_genus",
Expand Down
Loading
Loading