Data dictionary

[jacobvjk]

closes #50

• gains data_dictionary, which documents and explains the data structure of all outputs
• gains vignette data_ditionary.Rmd which provides some context for each output data set and shows the corresponding entry of the data dictionary in a DT::datatable

NOTE:

• column width is far from ideal in the vignette, but I wanted to get the content out first

[jacobvjk]

@cjyetman @AlexAxthelm I am a bit unsure why the R-CMD check gets hung up over no visible binding of internal data files. My understanding is that internal data should be available without further calls needed. That's how I interpret this at least: https://r-pkgs.org/data.html#sec-data-sysdata
Also seems to work in other packages, e.g. in pacta.multi.loanbook.analysis. Any idea what I am missing here?

[cjyetman]

@cjyetman @AlexAxthelm I am a bit unsure why the R-CMD check gets hung up over no visible binding of internal data files. My understanding is that internal data should be available without further calls needed. That's how I interpret this at least: https://r-pkgs.org/data.html#sec-data-sysdata Also seems to work in other packages, e.g. in pacta.multi.loanbook.analysis. Any idea what I am missing here?

I think R/sysdata.rda doesn't have the objects in it yet, you just have to run data-raw/auxiliary_data_sets.R first

e.g.

(load("~/github/rmi-pacta/workflow.multi.loanbook/R/sysdata.rda"))
#> [1] "data_dictionary"

[jacobvjk]

@cjyetman @AlexAxthelm I am a bit unsure why the R-CMD check gets hung up over no visible binding of internal data files. My understanding is that internal data should be available without further calls needed. That's how I interpret this at least: https://r-pkgs.org/data.html#sec-data-sysdata Also seems to work in other packages, e.g. in pacta.multi.loanbook.analysis. Any idea what I am missing here?

I think R/sysdata.rda doesn't have the objects in it yet, you just have to run data-raw/auxiliary_data_sets.R first

e.g.

(load("~/github/rmi-pacta/workflow.multi.loanbook/R/sysdata.rda"))
#> [1] "data_dictionary"

huh correct.. this is a case of "never assume" I guess

did you commit the new sysdata.rda?

[cjyetman]

hmmm... I was skeptical because the dif file viewer said that sysdata.rda only changed 9 Bytes, but I just ran it locally as is and it seems to be fine