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.

Sign up for GitHub

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

Jump to bottom

Update documentation in {austraits} for changes in version 3.0.0 #96

Closed
fontikar opened this issue Sep 5, 2024 · 3 comments
Closed

Update documentation in {austraits} for changes in version 3.0.0 #96

fontikar opened this issue Sep 5, 2024 · 3 comments
Assignees
@ehwenk
Labels
documentation 📝 Improvements or additions to documentation
Milestone
austraits 3.0

Comments

@fontikar
Copy link
Collaborator

fontikar commented Sep 5, 2024

We will be not longer supping AusTraits version <5.0.0 these were not compiled by traits.build

We need to update the helpfiles to:

  • give users of any traits.build databases an overview of the functionality of each function
  • let {austraits} users know about the lack of support for AusTraits version <5.0.0
@fontikar fontikar added this to the austraits 3.0 milestone Sep 5, 2024
@fontikar
Copy link
Collaborator Author

fontikar commented Sep 5, 2024 •
edited
Loading

A discussion about what the helpfile should look like began here

@fontikar suggested a section under @details for AusTraits users

@fontikar fontikar mentioned this issue Sep 9, 2024
Closed
7 tasks
@fontikar
Copy link
Collaborator Author

fontikar commented Sep 9, 2024 •
edited
Loading

Problem: By version 3.0.0, {austraits} is will become the home of "exploration/wrangling" functions of traits.build-built databases. Currently, all of the documentation is targeted to an AusTraits user.

What we need to do: All documentation will need to be updated and generalised to a wider audience, but we still need some info for AusTraits users.

  • README

  • Function documentation @ehwenk

The vision:

  • A more generalised description of the function and its paramaters and usage.

  • A subsection for every function for AusTraits users notifying them which functions is supporting which versions of the AusTraits database @ehwenk has a great good example of this but I can't seem to find it in slack!

  • Vignette/Long form documentation

    • Getting started vignette

  • The website

@fontikar
Copy link
Collaborator Author

fontikar commented Sep 9, 2024

Discussion:

Not all functions are austraits specific

Plot locations needs to be review to be generalised to lat lot

@fontikar fontikar mentioned this issue Sep 12, 2024
Closed
@fontikar fontikar changed the title Update function documentation in {austraits} about changes in {austraits} version 3.0.0 Update function documentation in {austraits} for changes in version 3.0.0 Sep 12, 2024
@fontikar fontikar changed the title Update function documentation in {austraits} for changes in version 3.0.0 Update documentation in {austraits} for changes in version 3.0.0 Sep 12, 2024
@ehwenk ehwenk moved this to In Progress in AusTraits Sep 13, 2024
@fontikar fontikar added the documentation 📝 Improvements or additions to documentation label Nov 15, 2024
@fontikar fontikar mentioned this issue Nov 16, 2024
Merged
@fontikar fontikar moved this from In Progress to Done in AusTraits Nov 17, 2024
@fontikar fontikar closed this as completed by moving to Done in AusTraits Nov 17, 2024
@fontikar fontikar mentioned this issue Nov 18, 2024
Merged
ehwenk pushed a commit that referenced this issue Nov 19, 2024
@fontikar
Major upgrades to {austraits} (#131)
02abab7 
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
Assignees

@ehwenk ehwenk

Labels
documentation 📝 Improvements or additions to documentation
Projects
AusTraits
Status: Done
Milestone
austraits 3.0
Development

No branches or pull requests
2 participants
@ehwenk @fontikar