Skip to content

About

Source for the traits.build R package, used to build AusTraits

Resources

Contributing

Stars

12 stars

Watchers

4 watching

Forks

Repository files navigation

The {traits.build} R package

R-CMD-check Codecov test coverage Lifecycle: stable

Imagine you wanted to build a database of traits. You might start by compiling data from existing datasets, but you'd quickly find that there are many ways to name and measure the same trait, that different studies use different units, or use an outdated name for a species or taxon.

The traits.build package provides a workflow for harmonising data from disconnected primary sources and arises from the AusTraits project austraits.org. In 2023 this package was spun out as a separate package from the austraits.build repository.

Goals

The goals of this package are to:

  1. Enable users to create open-source, harmonised, reproducible databases from disparate datasets.
  2. Provide a fully transparent workflow, where all decisions on how the data are handled are exposed.
  3. Offer a relational database structure that fully documents the contextual data essential to interpreting ecological data.
  4. Offer a straightforward, robust template for building a trait dictionary.
  5. Offer a database structure that is flexible enough to accommodate the complexities inherent to ecological data.
  6. Offer a database structure that is underlain by a documented ontology, ensuring each database field is interpretable and interoperable with other databases and data structures.
  7. Have no dependencies on proprietary software or costs to setup and maintain (beyond person time).

To handle the harmonising of diverse data sources, we use a reproducible workflow to implement the various changes required for each source to reformat it suitable for incorporation in a harmonised compilation. Such changes include restructuring datasets, renaming variables, changing variable units, changing taxon names.

Prerequisites

  1. Familiarity with the R programming language, covered in R for Data Science.
  2. Data science workflow management techniques.
  3. How to write functions to prepare data, analyse data, and summarise results in a data analysis project.
  4. Appreciation of the traits.build workflow, including the required file structure.

Installation

traits.build is not yet on CRAN. Install it from GitHub:

Type Command
Release remotes::install_github("traitecoevo/traits.build@v2.2.0")
Development remotes::install_github("traitecoevo/traits.build")

The development version comes from the develop branch, the repository's default. It reads each dataset's references from a source: block holding a dataset: entry (the dataset's own reference) and optional source: and secondary: lists; it no longer reads the older primary: / secondary_01: / original_01: shape that 2.2.0 uses. traits.build::metadata_convert_sources() converts a database's metadata.yml files.

The development version also installs traits.use, which it depends on.

Using a built database

traits.build compiles a database; to load, filter, join and plot a compiled one, use traits.use, the reader for any traits.build database. For AusTraits, the austraits package adds load_austraits() (load a release by version number) and a map of Australia on top of traits.use. traits.build re-exports traits.use's trait-distribution plots, which its dataset reports use.

Documentation

Tutorials

Help

Please read the help guide to learn how best to ask for help using traits.build.

Code of conduct

Citation

A publication describing the traits.build workflow:

Wenk E, Bal P, Coleman D, Gallagher R, Yang S, Falster D (2024) traits.build: A data model, workflow and R package for building harmonised ecological trait databases. Ecological Informatics 83: 102773. DOI: 10.1016/j.ecoinf.2024.102773

A publication describing the biggest database using the traits.build workflow:

Falster D, Gallagher R, Wenk, E et al. (2021) AusTraits, a curated plant trait database for the Australian flora. Scientific Data 8: 254. DOI: 10.1038/s41597-021-01006-6

AusTraits family

traits.build is part of the AusTraits family of packages maintained by the AusTraits team. See austraits.org for the project, the data, and the people behind it.

Contributing? Issues across the family are tracked on one board, AusTraits #9, and new issues are auto-added. Please read the issue & labelling guide in austraits-meta — the family's cross-package knowledge and governance hub — before filing.

Acknowledgements

AusTraits is made possible by contributions from our partner organisations — the University of New South Wales, Western Sydney University, Botanic Gardens of Sydney, the University of Melbourne, the Atlas of Living Australia, and the Australian Government Department of Climate Change, Energy, the Environment and Water — and from our advisory board, data contributors, and past partners.

AusTraits is a co-investment partnership with the Australian Research Data Commons (ARDC) through the Planet Research Data Commons (DOI: 10.3565/nyk4-4r91). The ARDC is enabled by the Australian Government's National Collaborative Research Infrastructure Strategy (NCRIS).

This work received investment (DP720) from the ARDC.

About

Source for the traits.build R package, used to build AusTraits

Resources

Contributing

Stars

12 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages