search

njtierney / datadevtools

Development tools for sharing data
7 stars 0 forks source link

using roxygen / doxygen for data documentation + testing #18

Open njtierney opened 4 years ago

njtierney commented 4 years ago

Data can be documenting with roxygen / doxygen - like in DataPackageR.

This can then be compiled into a codebook data description.

The documentation for the data can then be compared against the columns.

For example, if there are three columns in the dataset, there should be three variables documented.

This doxygen example will not store the data as an R data object, but should be able to be parsed using standard doxygen / JavaDoc.