-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
123 lines (79 loc) · 5.25 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
---
output: github_document
editor_options:
chunk_output_type: console
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%",
message = FALSE,
warning = FALSE
)
library(austraits)
library(stringr)
library(dplyr)
```
# austraits <img src="man/figures/austraits_hex.png" align="right" alt="" width="120" />
<!-- badges: start -->
[](https://github.com/traitecoevo/austraits/actions/workflows/R-CMD-check.yml)
[](https://codecov.io/gh/traitecoevo/austraits)
[](https://doi.org/10.1038/s41597-021-01006-6)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://app.codecov.io/gh/traitecoevo/austraits?branch=master)
<!-- badges: end -->
`austraits` allow users to **access, explore and wrangle data** from [traits.build](https://github.com/traitecoevo/traits.build) relational databases. It is also an R interface to [AusTraits](https://austraits.org/), the Australian plant trait database. This package contains functions for joining data from various tables, filtering to specific records, combining multiple databases and visualising the distribution of the data. We expect this package will assist users in working with `traits.build` databases.
### Installation
This package is not on CRAN yet and is still under active development. For the current stable release of `austraits`, which has full capabilities of the functions used in vignettes (e.g. plotting functions), use:
```{r setup, results = 'hide', eval = FALSE}
#install.packages("remotes")
remotes::install_github("traitecoevo/austraits", dependencies = TRUE, upgrade = "ask")
library(austraits)
```
For a lightweight installation where dependencies for plotting and producing the vignettes will not be installed, use:
```{r light, results = 'hide', eval = FALSE}
remotes::install_github("traitecoevo/austraits", upgrade = "ask")
```
### Details for AusTraits users
#### Retrieve AusTraits data
- **For R users**, the AusTraits database can be accessed through the `austraits` package using `load_austraits()`
- **For Python or other users**, the [Zenodo download](https://zenodo.org/record/5112001#collapseTwo) includes a `.zip` file containing all the data in plain text (`.csv` files) and associated meta-data
#### Backwards compatibility with past AusTraits versions
From September 2024, `austraits` functions were revamped to support all [traits.build](https://github.com/traitecoevo/traits.build) compiled databases, rather than being linked to [austraits.build](https://github.com/traitecoevo/austraits.build).
Versions of `austraits.build` (the AusTraits plant trait database) **< 5.0 are no longer supported** by the latest version of the package. If you are working with an older version of AusTraits, please install an older version of austraits:
For `austraits.build` versions 4.2 and older:
```{r backwards, results = 'hide', eval = FALSE}
#install.packages("remotes")
remotes::install_github("traitecoevo/[email protected]", dependencies = TRUE, upgrade = "ask")
library(austraits)
```
Note, if you are unsure what version of AusTraits you are working with, run:
```{r version, results = 'hide', eval = FALSE}
austraits$build_info$version
```
### Getting started `r emo::ji("eyes")`
We highly recommend taking a look at our [Getting Started tutorial](https://traitecoevo.github.io/austraits/) on our website before jumping into the `austraits` R package!
If you prefer to view this vignette in R, we recommend installing the package with `build_vignettes = TRUE`.
```{r, eval = FALSE}
remotes::install_github("traitecoevo/austraits",
dependencies = TRUE, upgrade = "ask",
build_vignettes = TRUE)
vignette("austraits")
```
### Cheat sheet
<a href="https://github.com/traitecoevo/austraits/tree/master/inst/cheatsheet/austraits-cheatsheet.pdf"><img src="man/figures/austraits-cheatsheet.png" width="60%"/></a>
### Learn more about AusTraits
AusTraits is a relational database, you can learn more about it's structure from the [traits.build book](https://traitecoevo.github.io/traits.build-book/AusTraits_tutorial.html).
You can also learn about the definitions of each plant trait with the [AusTraits Plant Dictionary!](https://w3id.org/APD)
### Show us some support `r emo::ji("green heart")`
Please consider citing `austraits`, we would super appreciate it!
```{r}
citation("austraits")
```
### Behind the scenes `r emo::ji("spanner")`
Check out [austraits.build](https://github.com/traitecoevo/austraits.build?tab=readme-ov-file), if you are interested in how AusTraits the database is managed and created
### Find a bug? `r emo::ji("bug")`
Thank you for finding it! Head over to the GitHub Issues tab and let us know about it! We will try to get to it as soon as we can!