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

Mass removal of version switches #102

Merged
merged 28 commits into from
Sep 12, 2024
Merged

Mass removal of version switches #102

merged 28 commits into from
Sep 12, 2024

Conversation

fontikar
Copy link
Collaborator

Addresses #91

Removal of switches

  • The following functions will no longer support AusTraits version < 5.0.0:
    • extract_*
    • trait_pivot_wider
    • join_*
    • plot_locations
    • plot_trait_beeswarm
    • as_wide_table

Changes to existing functions

  • plot_locations and trait_pivot_wider now accepts either traits table OR traits.build list object
  • summarise_trait_means will trigger warning due to uninformed calculation of means.

Deprecations

  • plot_site_locations and trait_pivot_longer are deprecated

Addition of helper functions to assist with removal of switches

  • Added internal function to check the compatibility of databases
  • Added internal function notify users that some database versions will not be supported

@fontikar fontikar requested a review from dfalster September 12, 2024 03:20
@fontikar fontikar changed the base branch from master to develop September 12, 2024 03:28
Copy link
Member

@dfalster dfalster left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A massive effort, well done. This all looks magnificent, and reflecting our various discussions. Well done @fontikar @ehwenk

R/as_wide_table.R Outdated Show resolved Hide resolved
@fontikar fontikar added this to the austraits 3.0 milestone Sep 12, 2024
@fontikar fontikar merged commit 1c10ad1 into develop Sep 12, 2024
5 checks passed
@fontikar fontikar deleted the rm-switch-rollout branch September 12, 2024 22:23
ehwenk pushed a commit that referenced this pull request Nov 19, 2024
As discussed in issue #92, the goal of this upgrade was to:

  1. Discontinue support for AusTraits version < 4.2.0
    - Mass removal of switch functions that controlled function behaviour depending on AusTraits version (Issue #102, issue #91)
    - Creation of check_compatibility() (Issue #100)
    - Console messaging alerting user which version of AusTraits is supported by which functions (Issue #100)
    - Updated documentation guiding user on how to install an older version of the R package for backwards compatibility (Issue #93)

  2. Introduce new traits.build 'wrangling output' functions into austraits
    -  flatten_database added to austraits (Issue #105)
    -  bind_databases added to austraits (Issue #106)

  3. Reduce redundancy across traits.build and austraits to streamline codebase maintenance
    -  plot_trait_beeswarm moved back to austraits
    -  trait_pivot_ moved back to austraits

  4. Refactor {austraits} functions to support other traits.build databases and allow functionality across more tables and columns.
    -  join_ functions (Issue #91)
    -  extract_ functions (Issue #107)
    -  Rename argument names (Issue #115)

  5. Update documentation accordingly    -  Pointing to APD and traits.build-book directly in README and vignette 

Update documentation in {austraits} for changes in version 3.0.0 #96
Update documentation with reference to manual #74
Added cheatsheet
________________________
co-authored by @ehwenk and @dfalster
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants