From 638fd1bdeba0c034ea078ccae73437cef3e5c499 Mon Sep 17 00:00:00 2001 From: Sven <37927107+SvenVw@users.noreply.github.com> Date: Fri, 29 Nov 2019 11:12:12 +0100 Subject: [PATCH 1/3] Add the column description and vignette about it --- R/tables.R | 17 +++++++- data/column_description_obic.RData | Bin 0 -> 3332 bytes man/column_description.obic.Rd | 22 ++++++++++ vignettes/description-of-the-columns.Rmd | 30 ++++++++++++++ .../explaination-of-the-OBIC-package.Rmd | 38 ------------------ 5 files changed, 68 insertions(+), 39 deletions(-) create mode 100644 data/column_description_obic.RData create mode 100644 man/column_description.obic.Rd create mode 100644 vignettes/description-of-the-columns.Rmd delete mode 100644 vignettes/explaination-of-the-OBIC-package.Rmd diff --git a/R/tables.R b/R/tables.R index b7228658..be4f59e8 100644 --- a/R/tables.R +++ b/R/tables.R @@ -49,4 +49,19 @@ #' \item{var}{The name of the weight} #' \item{weight}{weighing factor} #' } -"weight.obic" \ No newline at end of file +"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" \ No newline at end of file diff --git a/data/column_description_obic.RData b/data/column_description_obic.RData new file mode 100644 index 0000000000000000000000000000000000000000..635756f8a028e8cd8761810cec7be5978540b195 GIT binary patch literal 3332 zcmV+f4g2!_H+ooF0004LBHlIv03iV!0000G&sfahH@^(VT>vQ&2UKVgRpoBy+ zQ-+i~vA?RPq{S?_s@AS3`S$H4eUt2`=Swv4a0tLaGaq zC&W%1IZPvcy^`MEdiv!|f+HDhAV1gp<}EsBZIy`zNT!5zb=U40xuT!`^Tl%MM$FF| zZK{jOxe_`F8?&@Jj{49PJOOm#767r8n8#CoJnKsr(|DFvzcL7%aD=-+EZYI z@b`u|GK04$=7biy%jAX4s^s3U3-esD9bTh$;)BL?Mqw4!635)zBum^p(tHNNX!_zL zZB`61OX2vYN@Gb<15fJu+C*|Ta_XtdRW{qD&;At#!U_tqAK%!Mff(>eG`@Kv zkmqbh5?E#_i4q4jpb|XaDV>IszKG`kRuR5$_c@#X!j^0rkkXf~L`=$5A&i?n*){GC zwt7Qvp^DK*TiQ~brV~raXbNlQeKJUI4zgz8wD*JUI#;8a=wSPz3yQwzPCno8E1Kib zRJXJT;7GkW#&KaSFDMpqev_W`*|X;#Oqzhl4h z1k-xzO&*~nDoX}r9@|)LwRi(#rj`9vS<0{UGV%?+_1N8m)m0rg85iszX?L&Pt4}C6 z?Tvg>Ej!(bXtcS|%HBEPTr>(?u5)7>E z>&1wE+?6I}>t*uwaR-H}_#>xkJnR$LG8biMCS5?2Mq_$#>4a+H{ibM<^jcuo%z#KD zEd^a?vPxwNQVZ1mt-I+p>%`9fto)tALywt?xZabiw%KqCQQyZe93@m#}*= z)|gxtuu&oH051$4;Z{zNd{?fkd{l;i14f$Te*Cm3OdEBw2POP+toKQ0`FRqB>>Z7v=KFcKN zU$L1uhMc>dJBJ?RN%{1QZCXV|7TzlFM9Nr%m1I?9OhcfimGb%5D>LIcsbBp6-P9f^ zfHOuQVlh3x%Q{bWu@325YW(^QUW#%!8;<3t0lQzAo(rLqZFU7p+2lxYie69^tX z$C*B6lufZVy=$w8-Y8LQUrsi%CspF;K3%k{U$X(%tonf-DvSHUcpnpEqgb-AhCM=r zrK`9Z8g>#{;TDx0=5o$o8WfqRzCm%ZXyZ4P=KXsu%=<1k+^yv}h@@^3^^7sTEZO~)@yjZig2k*tPQsG3y7vP$;w_i#uV6UrqgRcqQq{M zXymJ^ZmwIAPnglca-cXNL^{@c-XWQAJ(ONSgRmW=DVdM^5SvY;k_-+!)yz9@UjOHk zUS=KrtPi{DFchy$$w)F$<{3YbBt6USAwQ?e3wNdlQJUdc)S-RQrTi2H1Mil@Z@y)( z&BhtnzqL=*E<|UJIw=?r2_q3O+h6c6*KFUwAAAw$;3_hbwVAcfcU;=@gyPy}E=-7C zRfz;t7)>CbGmg2MwvA*0ZCP&}q9F-&wM9Lh&Ng#j4?1$k1Y+5A%omb!@Lt>5BZd91y4Fh;do0L$s4&>>;E%z<5C!Kv44!fRCqMmR0V|WM z2^=d3uuTrouV3rOBS@~=1^2s{mCW&>A8PNQI_IqO)bJw#hj32rvMEBdfxyXD=%Hdh zAn4i?feO0GVeH0`@~<%Er1kwsBFlcb>Lh)Z$2PzeEqx0s6{%OXsXY!sap=ch#F~Q( z%kcny8$>jna9a`wquY{hG4$Z4gT!xy8Gjx`eFg&FL?zVh)-(br0bNg9_u|gJEX$1s z!NceFSZQiN2ieZ9UFc2l5JYk+W*U|!9hK{moi5E6tJ8< z7LsKs9Nt7etCq6O16(WTGad&rx~#5(#B-T%!|H?sPN*31vfx1WJOt3;j>QNxp&8Vp z%Qfr;74tV)zb=ZliDikr%<$Kg$%@+s4bC7s$g4P@guc{3 zbG%9mF^q@j&!tmVKbFiquI0wLF!@wm9Vb-A2Kh&g9k(o-tpAb$7>Oml6BpkV4Db_s zDBMLv=Bsm#Tp;zd*{{1$_MPCbGThh{U;^}hj5yH8+tlcX8j3$;K+R$f!{~U598*t_ zjCgZ&F@BBJ@+Q!v6+Q?CdeIGV@@w{U911abkC7+l&ps$0(>7Lik-_m>U54pC7_nPd01Cs3~ z^T%RogvPI2AYaoa?}vevSi)ICX8u%6EdH`N#hdf$J@GTg0iBj1xwdxaGqRAD2- z#kh0-H{o*^EvkEepNNE%6xDeRt5|3ICIFSslFoN)V!I6})L!Bk7k=XufjCR$zJ~+W z*Ya<21r;S|_x0a=h1 z3`iBQfeafu`G|DYset0vV#d4`O`FVea$>Qx;LK9brbtFzRa6L?vrr>Y)^eZ+MVLb6 zQXBzjs`f-iLl~}0E%I-p)931C;n{8bTBC`hyq_Go02MqXHwFoQR7$~?h5X8Hgmc^; zI-Z!e4b9%qPWp(0P5!-t8~d)6;oUPewSs&;FWaBB-$dI1{(4C^j(y8~n%Q-Nx!jS0 z&zkk0%~5IR)AOvMFys>h?eWxeM2^}iq!h=>q>f^~NG)S3Rxf+CIzDX4*$;fDyv;86 zv;mMG9{b;I>rsJrbwvCIM)`gSzaBQ|4#Dj;=U4L3y9nG3?qUgpok08!<3RN#Xp8hm9(ChgUC`A zzPdX8>c!jE!u<{^1Bjk7gnr0O?0FmagnqD)Zqk6d5_jikWmxdt-S#JiZ|l?+oTTWc z?i)PnuVph@NzHPl& zHfS0J>>yHWO-K$7TI@vhlar>(iG`@%!9VaaloD7uf%VgivI8v?MpO$c>G$8V-t&|g z3RE590I#wFhY$X6uDmHVp@b~?SIITP;QsXz-%Vbns3!!b&QCY>;aZi!h+w&-l;;wA z-2{bZvO73i076meIRf%>1~c1BEl9p!&cTR3+!8>6?13qe^wkkH$GgBKn@kC;j7$wA z?+j1lmDA&n0VXyg(a2bi@CqgxY$dB8RH`04xlpZHtH71eIl^s_bgH(luDtqM9Cj3i zJH~{U^3ydFSp))RLBHp}@U8o(eI(*5?H4b3D|_HT_jIDpttpJ7_R&oPqFO`_d3K literal 0 HcmV?d00001 diff --git a/man/column_description.obic.Rd b/man/column_description.obic.Rd new file mode 100644 index 00000000..acf96d78 --- /dev/null +++ b/man/column_description.obic.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/tables.R +\docType{data} +\name{column_description.obic} +\alias{column_description.obic} +\title{Column description for the OIC} +\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} +}} +\usage{ +column_description.obic +} +\description{ +This table defines the columns used in the OBIC and which unit is used +} +\keyword{datasets} diff --git a/vignettes/description-of-the-columns.Rmd b/vignettes/description-of-the-columns.Rmd new file mode 100644 index 00000000..252ca93e --- /dev/null +++ b/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) +``` diff --git a/vignettes/explaination-of-the-OBIC-package.Rmd b/vignettes/explaination-of-the-OBIC-package.Rmd deleted file mode 100644 index a06596f9..00000000 --- a/vignettes/explaination-of-the-OBIC-package.Rmd +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Explaination of the OBIC package" -author: "Sven Verweij & Gerard Ros" -date: "`r Sys.Date()`" -output: rmarkdown::html_vignette -vignette: > - %\VignetteIndexEntry{explaination-of-the-OBIC-package} - %\VignetteEngine{knitr::rmarkdown} - %\VignetteEncoding{UTF-8} ---- - -```{r, include = FALSE} -knitr::opts_chunk$set( - collapse = TRUE, - comment = "#>" -) -``` - -```{r setup} -library(OBIC) -``` - -## Introduction - -The `OBIC` package contains the functions for the Open Bodem Index. The purpose of these functions is to evaluate the soil for agricultural purposes. - -## Input data - -## Indices - -### Crumbleability - -### Phosphate availability - -### Soil sealing - -### Soil resistance - From a9b6646a0b1f268be2634020f46caaf13a3aa228 Mon Sep 17 00:00:00 2001 From: Sven <37927107+SvenVw@users.noreply.github.com> Date: Fri, 29 Nov 2019 11:13:19 +0100 Subject: [PATCH 2/3] update changelog --- NEWS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/NEWS.md b/NEWS.md index a652ce06..1375afa9 100644 --- a/NEWS.md +++ b/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 ### Changed * Update of crumbeability groups in `crops.obic` From 3663dac272ab7c16eccea56ae5a1086c6a17862f Mon Sep 17 00:00:00 2001 From: Sven <37927107+SvenVw@users.noreply.github.com> Date: Fri, 29 Nov 2019 11:15:15 +0100 Subject: [PATCH 3/3] update pr reference --- NEWS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index 1375afa9..16140082 100644 --- a/NEWS.md +++ b/NEWS.md @@ -3,7 +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 +* Adds a table with the description of the columns and a vignette about it #46 ### Changed * Update of crumbeability groups in `crops.obic`