Skip to content

Revise README for clarity and add references #23

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

Open
dlebauer wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −30
Open

Revise README for clarity and add references #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 9 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
[![License: ODC-By-1.0](https://img.shields.io/badge/data%20license-ODC--By--1.0-green.svg)](https://opendatacommons.org/licenses/by/1-0/)
[![DOI](https://img.shields.io/badge/Paper-10.1111%2Fgcbb.12420-blue.svg)](https://doi.org/10.1111/gcbb.12420)

**betydata** provides offline access to public data from the [BETYdb: Biofuel Ecophysiological Traits and Yields Database](https://betydb.org). This R data package enables reproducible analyses of plant traits, crop yields, and ecosystem service data without requiring database connectivity.
**betydata** provides offline access to public data from [BETYdb](https://betydb.org), ([LeBauer et al, 2018](https://doi.org/10.1111/gcbb.12420)). This R data package enables reproducible analyses of plant traits, crop yields, and ecosystem service data without requiring database connectivity.

> BETYdb stands for "Biofuel Ecophysiological Traits and Yields Database", but species and trait coverage is broad, and covers ecosystems from the tropics to the tundra.

---

Expand Down Expand Up @@ -126,9 +128,9 @@ To submit corrections via pull request, edit the relevant CSV file in `data-raw/

---

## Key Traits and Yields
## Key Traits

The `traitsview` table contains measurements of ecophysiological traits and crop yields:
The `traitsview` table contains measurements of ecophysiological traits and crop yields. These are some of the most common traits:

### Common Traits

Expand All @@ -137,9 +139,6 @@ The `traitsview` table contains measurements of ecophysiological traits and crop
* **leafN** -- Leaf nitrogen content (%)
* **height** -- Plant height (m)
* **LAI** -- Leaf Area Index (m2/m2)

### Yield Variables

* **Ayield** -- Above-ground yield (Mg/ha)
* **AGBiomass** -- Above-ground biomass (Mg/ha)

Expand All @@ -152,30 +151,6 @@ variables |>

---

## Data Formats

### .rda (Default)

Lazy-loaded R data objects, available after `library(betydata)`:
```r
traitsview
```

### Frictionless Data Package

Machine-readable metadata following the Frictionless data standard:
```json
// datapackage.json (repo root)
{
"name": "betydata",
"title": "BETYdb Plant Traits and Yields Data Package",
"licenses": [{"name": "ODC-By-1.0", ...}],
"resources": [...]
}
```

---

## Vignettes

Detailed tutorials are available as package vignettes:
Expand All @@ -189,3 +164,7 @@ Detailed tutorials are available as package vignettes:
```r
browseVignettes("betydata")
```

## Reference

LeBauer, D., Kooper, R., Mulrooney, P., Rohde, S., Wang, D., Long, S.P. and Dietze, M.C. (2018), BETYdb: a yield, trait, and ecosystem service database applied to second-generation bioenergy feedstock production. GCB Bioenergy, 10: 61-71. https://doi.org/10.1111/gcbb.12420
Loading