-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
89 lines (59 loc) · 3.77 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
---
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 the AusTraits database in `R`. This package includes several functions such as filtering and pivoting the dataset that we expect will come in handy.
**For R users**, access and manipulation of the data is assisted with the `austraits` package
**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
### Installation
The 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)
```
Otherwise, for a lightweight installation where dependencies for plotting and the vignettes will not be installed, use:
```{r light, results = 'hide', eval = FALSE}
remotes::install_github("traitecoevo/austraits", upgrade = "ask")
```
### Take a good look at our vignettes! `r emo::ji("eyes")`
In our website, we have also included information about the [structure of the database](https://traitecoevo.github.io/austraits/articles/structure.html), [definitions of the traits](https://traitecoevo.github.io/austraits/articles/dictionary.html) and some [tutorials](https://traitecoevo.github.io/austraits/articles/austraits.html) that uses our functions as well as some `tidyverse` functions to create some commonly used data output formats. We highly recommend starting here before jumping into the database!
If you prefer to view the vignettes 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")
```
### 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](http://traitecoevo.github.io/austraits.build/), 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!