Document all data in data/ about allodb HOT 8 CLOSED

@gonzalezeb

Please review the documentation of each exported dataset. Although the exported datasets live in data/, their documentation lives in R/data.R. You seem to have already written some useful information that now lives in data-raw/data.Rmd. I suggest you remove duplication: Document each dataset in R/data.R and then simply cite that documentation elsewhere. For example, if in data-raw/data.Rmd you want to provide details about the dataset equations, don't write those details directly; instead point to the help file of equations by writing "see ?equations". If this is unclear, let me know.

You may edit the skeleton that I wrote; later I can edit your work to apply roxygen2 syntax (which is the easiest way to create R help-files). FYI, here is a short explanation about how to document data -- althought it is a little out of date and now writing documentation is much easier because roxygen2 supports rmarkdown syntax (see this article).

You will notice that I documented each dataset and its correspoinding dataset_metadata in way that makes them appear in the same help-file. That way a single help file (accessed with any of ?dataset or ?dataset_metadata) explains what those two closely related datasets mean. The approach I am using uses the roxygen2 tags @name and @rdname; you can find more information about this approach here (although it refers to functions and not datasets, it works in the same way for both).

from allodb.

Here are some resources for inspiration about how to document datasets.

# Comes by default with R
?datasets::airquality

# install.packages("ggplot2")
?ggplot2::diamonds

install.packages("gapminder")
?gapminder::gapminder
# To see other datasets in the gapminder package type gampinder:: and then hit tab

from allodb.

Just tried to improve documentation but got stuck with my lack of skills (ie. how to built a table that will go under 'Format' when calling ?equations...)..We can work on this later.

from allodb.

There is the roxygen tag @format. IT would look like this:

#' @format 
#' stuff

But I haven't used @format a lot so I'm unsure what you can and can't do in it. Can I see the table you want to add?

from allodb.

I want equation_metadata to look like the table in ?datasets::airquality when using the help file for ?equation

I tried something in commit 1cafffb, but nothing happened

from allodb.

#' Tables of allometric equations and associated metadata for ForestGEO sites.
#'
#' A dataset of best available allometry equations to calculate AGB per species
#' per ForestGEO site:
#' * `equations`: Table of allometric equations.
#' * `equations_metadata`: Table of metadata of `equations`.
#'
#' @details
#' A data frame with 154 observations on 6 variables.
#' @details
#' ```
#' [,1]	Ozone	 numeric	 Ozone (ppb)
#' [,2]	Solar.R	 numeric	 Solar R (lang)
#' [,3]	Wind	 numeric	 Wind (mph)
#' [,4]	Temp	 numeric	 Temperature (degrees F)
#' [,5]	Month	 numeric	 Month (1--12)
#' [,6]	Day	 numeric	 Day of month (1--31)
#' ```
"equations"

#' @rdname equations
"equations_metadata"

from allodb.

I'll push tihis one.

#' Tables of allometric equations and associated metadata for ForestGEO sites.
#'
#' A dataset of best available allometry equations to calculate AGB per species
#' per ForestGEO site:
#' * `equations`: Table of allometric equations.
#' * `equations_metadata`: Table of metadata of `equations`.
#'
#' @format
#' A data frame with 154 observations on 6 variables.
#' ```
#' [,1]	Ozone	 numeric	 Ozone (ppb)
#' [,2]	Solar.R	 numeric	 Solar R (lang)
#' [,3]	Wind	 numeric	 Wind (mph)
#' [,4]	Temp	 numeric	 Temperature (degrees F)
#' [,5]	Month	 numeric	 Month (1--12)
#' [,6]	Day	 numeric	 Day of month (1--31)
#' ```
"equations"

from allodb.

Closing (finally!) because all functions and datasets have been documented

from allodb.