Open
Conversation
Updated README to enhance clarity and provide reference.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project README to improve introductory clarity and add a formal literature reference for BETYdb/betydata.
Changes:
- Updates the opening description to include an inline citation and adds explanatory context about BETYdb coverage.
- Renames the “Key Traits and Yields” section to “Key Traits” and adjusts the introductory text for that section.
- Adds a full “Reference” section with the LeBauer et al. (2018) citation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
131
to
143
| @@ -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) | |||
There was a problem hiding this comment.
The section heading says "Key Traits", but this section still lists yield variables (e.g., Ayield, AGBiomass) and the intro sentence says it includes "crop yields". Consider renaming the heading back to include yields, or split traits vs yield variables with clear subheadings so the content matches the title.
| [](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. |
There was a problem hiding this comment.
The opening citation punctuation reads a bit off: "from BETYdb, (LeBauer et al, 2018)". Elsewhere in this README the manuscript vignette uses "LeBauer et al. (2018)"; it would be clearer/consistent to drop the comma before the parenthetical and include the period after "al.".
Suggested change
| **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. | |
| **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. |
| **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. |
There was a problem hiding this comment.
This blockquote sentence is a bit redundant/awkward ("coverage is broad, and covers ..."). Consider rephrasing to avoid repeating "cover" and to improve readability.
Suggested change
| > 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. | |
| > BETYdb stands for "Biofuel Ecophysiological Traits and Yields Database", but species and trait coverage is broad, spanning ecosystems from the tropics to the tundra. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated README to enhance clarity and provide reference.