Skip to content

Commit 3210c15

Browse files
committed
update package and dataset documentation
1 parent 302179a commit 3210c15

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

R/betydata-package.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' betydata: Public Data from the BETYdb Database
22
#'
33
#' Offline access to plant trait and yield data from BETYdb.
4-
#' Load datasets with `data(traitsview)`, `data(species)`, etc.
4+
#' All tables are lazy-loaded and available after `library(betydata)`.
55
#'
66
#' @seealso [traitsview], [species], [sites], [variables], [pfts], [priors]
77
#' @keywords internal

R/data.R

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@
33
#' Traits and yields from BETYdb
44
#'
55
#' A denormalized view combining plant trait measurements and crop yield data
6-
#' from the BETYdb database. This is the primary dataset for offline analysis.
6+
#' from the BETYdb database. This is the primary table for offline analysis.
7+
#' Columns are ordered with key analytical fields first (trait, mean, units,
8+
#' scientificname, genus) and ID columns last.
79
#'
8-
#' @format A data frame with trait and yield observations.
9-
#' Use `names(traitsview)` to see all columns. Key columns include
10-
#' checked (quality flag), result_type, id, mean, units, trait, and scientificname.
10+
#' @format A tibble with 43,532 rows and 35 columns.
11+
#' Key columns: trait, mean, units, scientificname, genus, sitename, author.
12+
#' Use `names(traitsview)` to see all columns.
1113
#' @source <https://betydb.org>, exported from traits_and_yields_view
1214
#' @seealso [species], [sites], [variables], [citations]
1315
#' @examples
14-
#' head(traitsview)
16+
#' traitsview
1517
#' names(traitsview)
1618
"traitsview"
1719

0 commit comments

Comments
 (0)