An open API service indexing awesome lists of open source software.

https://github.com/traitecoevo/austraits.build

Source for AusTraits
https://github.com/traitecoevo/austraits.build

australia database ecology plants

Last synced: 5 months ago
JSON representation

Source for AusTraits

Awesome Lists containing this project

README

          

# `austraits.build`: source for `AusTraits`

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3568417.svg)](https://doi.org/10.5281/zenodo.3568417)
[![build](https://github.com/traitecoevo/austraits.build/actions/workflows/check-build.yml/badge.svg)](https://github.com/traitecoevo/austraits.build/actions/workflows/check-build.yml)

![](inst/figures/logo.png)

AusTraits is a transformative database, containing measurements on the traits of Australia’s plant species, standardised from hundreds of disconnected primary sources. So far, data have been assembled \> 300 distinct sources, describing > 500 plant traits for > 25k taxa. The dataset and approach is documented in detail in the following publication

> 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](http://doi.org/10.1038/s41597-021-01006-6)

The repo contains the data for rebuilding AusTraits, while the workflow to rebuild the dataset is on the [traits.build repo](https://github.com/traitecoevo/traits.build).

AusTraits is continually evolving, as new datasets are contributed. As such, there is no single canonical version. We are continually making new versions available. Overtime, we expect that different versions will be released and used in different analyses.

## Accessing data

Those interested in simply using data from AusTraits, should visit download the compiled resource from the versioned releases archived on Zenodo at DOI: [10.5281/zenodo.3568417](https://doi.org/10.5281/zenodo.3568417).

Users will want to read up on the [database structure, described in the `traits.build` manual](https://traitecoevo.github.io/traits.build-book/database_structure.html).

Definitions for the traits are described the AusTraits Plant Dictionary (APD), at

- Formalised vocabulary at

> A publication describes this vocabulary: Wenk EH, Sauquet H, Gallagher RV, Brownlee R, Boettiger C, Coleman D, Yang S, Auld T, Barrett RL, Brodribb T, Choat B, Dun L, Ellsworth D, Gosper C, Guja L, Jordan GJ, Breton T, Leigh A, Irving P, Medlyn B, Nolan R, Ooi M, Sommerville KD, Vesk P, White M, Wright IJ, Falster DS (2024) The AusTraits Plant Dictionary. *Scientific Data* 11:537. DOI: [10.1038/s41597-024-03368-z](http://doi.org/10.1038/s41597-024-03368-z)

## Citation

Users of AusTraits are requested to cite the source publication, which documents the dataset and approach:

> 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](http://doi.org/10.1038/s41597-021-01006-6)

## Rebuilding AusTraits from source

This repository (`austraits.build`) contains the raw data to compile AusTraits from diverse, original sources.

![](inst/figures/Workflow.png)

We use the [`traits.build`](https://traitecoevo.github.io/traits.build/) R package and workflow to harmonise > 400 different sources into a unified dataset. The workflow is fully-reproducible and open, meaning it exposes the decisions made in the processing of data into a harmonised and curated dataset and can also be rerun by others. AusTraits is built so that the database can be rebuilt from its parts at any time. This means that decisions made along the way (in how data is transformed or encoded) can be inspected and modified, and new data can be easily incorporated.

A publication describes the `traits.build` workflow:
> Wenk EH, Bal P, Coleman D, Gallagher RG, Yang S, Falster DS, (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](https://doi.org/10.1016/j.ecoinf.2024.102773)

To build the database follows these steps

***Install `traits.build`***

The first step is to install a copy of [traits.build](https://github.com/traitecoevo/austraits.build/):

```{r, eval=FALSE, echo=TRUE}
remotes::install_github("traitecoevo/traits.build", quick = TRUE)
```
***Clone repository***

Next you need to download a copy of this repository from GitHub. Then open the Rstudio project, or open R into the right repo directory.

***Build***

Building the database should then be as easy as running the code in the file `build.R`. Note this code can use multiple CPUs, to do this, change the number of workers to > 1.

```
source("build.R")
```

After running, you should have an object `austraits` available in your workspace, as well as a version saved in `export/data`.

## Updating the build script

To update the build process

```
traits.build::build_setup_pipeline(method="furrr", database_name = "austraits", workers = 1)
```

## Contributing to AusTraits

We envision AusTraits as an ongoing collaborative community resource that:

1. Increases our collective understanding of the Australian flora
2. Facilitates the accumulation and sharing of trait data
3. Builds a sense of community among contributors and users
4. Aspires to be fully transparent and reproducible research of the highest standard.

We'd love for you to contribute to the projects. Below are some ways you can contribute:

- Contributing new data
- Improving data quality and reporting errors
- Improving documentation
- Development of `traits.build`` workflow

For details on on how to contribute, please see the file [CONTRIBUTING.md](https://github.com/traitecoevo/austraits.build/blob/develop/.github/CONTRIBUTING.md)

The AusTraits project is released with a [Contributor Code of Conduct](https://github.com/traitecoevo/austraits.build/blob/develop/.github/CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.
## Acknowledgements

**Funding**: This work was supported via the following investments:

- Investment (https://doi.org/10.47486/TD044, https:// doi.org/10.47486/DP720) from the Australian Research Data Commons (ARDC). The ARDC is funded by the National Collaborative Research Infrastructure Strategy (NCRIS).
- Fellowship from the Australian Research Council to Falster (FT160100113), Gallagher (DE170100208) and Wright (FT100100910),
- A UNSW Research Infrastructure Grant to Falster, and
- A grant from Macquarie University to Gallagher.

**Recognition**: Many people have contributed to AusTraits. A list of contributors is provided on the on Zenodo at DOI:
[10.5281/zenodo.3568417](https://doi.org/10.5281/zenodo.3568417).

Further information about the AusTraits project is available at the project website [austraits.org](https://austraits.org).

**Resuse**: At this stage, only the compiled AusTraits dataset is available for reuse, via Zenodo. The raw data sources provided in this repository are not available for reuse in their current form, without further discussion from data contributors.