dataMaid icon indicating copy to clipboard operation
dataMaid copied to clipboard

Dataset metadata

Open vorpalvorpal opened this issue 3 years ago • 1 comments

I might be missing something, but it looks like there is no way to have dataset level metadata attached to a codebook. Things like:

  • Title
  • Description
  • Purpose
  • Author
  • Funder
  • Organization
  • Method

Is this something that you would consider adding? Possibly integrating with the dataspice package?

vorpalvorpal avatar Jan 25 '22 07:01 vorpalvorpal

First, note that dataMaid is no longer being maintained or updated. We have renamed the package to dataReporter, so we will appreciate if any future issues are posted there: https://github.com/ekstroem/dataReporter

Aside from that, this is a good idea and something I will definitely look into the next time I work on updates. Thank you for suggesting it.

But in the meantime, we do have a few manual options for getting something similar to what you request. If you are familiar with working in Rmarkdown, note that our codebook can be generated without the YAML header so they can easily be included as a "child" document:

library(dataReporter)
makeCodebook(presidentData, standAlone = FALSE)

This produces a file, "codebook_presidentData.Rmd", which can then be included in another Rmarkdown document as a child with a code chunk like this:

```{r, child = "codebook_presidentData.Rmd"}

That would allow you to manually insert any extra information before/after the codebook in your Rmarkdown document.

annennenne avatar Jan 28 '22 09:01 annennenne