Merge pull request #46 from springgbv/add-column-description

Add description of the columns for the OBIC

NEWS.md

@@ -3,6 +3,7 @@
 ## UNRELEASED 
 ### Added
 * Adds the leaching of nitrogen to surface water and groundwater #17
+* Adds a table with the description of the columns and a vignette about it #46
 
 ### Changed
 * Update of crumbeability groups in `crops.obic`

R/tables.R

@@ -49,4 +49,19 @@
 #'   \item{var}{The name of the weight}
 #'   \item{weight}{weighing factor}
 #' }
-"weight.obic"
+"weight.obic"
+
+#' Column description for the OIC
+#' 
+#' This table defines the columns used in the OBIC and which unit is used
+#' 
+#' @format A data.frame with 126 rows and 6 columns:
+#' \describe{
+#'   \item{column}{The column name used in OBIC}
+#'   \item{type}{The type of column}
+#'   \item{description_nl}{A description of the column in Dutch}
+#'   \item{description_en}{A description of the column in English}
+#'   \item{unit}{The unit used for this column}
+#'   \item{method}{The method to measure/obtain the values for this column}
+#' }
+"column_description.obic"

vignettes/description-of-the-columns.Rmd

@@ -0,0 +1,30 @@
+---
+title: "Description of the columns for OBIC"
+date: "`r Sys.Date()`"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{description-of-the-columns}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(OBIC)
+```
+
+
+The main function of the package `obic()` requires as input a `data.table` with specific columns.
+These columns are specified in `OBIC::column_description.obic` and can also be seen in the table below
+
+
+```{r table}
+desc <- OBIC::column_description.obic
+knitr::kable(desc)
+```