codebook icon indicating copy to clipboard operation
codebook copied to clipboard

auto-generate rdoc for datasets

Open rubenarslan opened this issue 6 years ago • 2 comments

Maybe this exists already. Find out:

  • [ ] how frequently R datasets are documented like this
  • [ ] existing readers
  • [ ] existing writers
  • [ ] existing translators.
@format A data frame with NNNN rows and NN variables:
\describe{
  \item{subject}{Anonymized Mechanical Turk Worker ID}
  \item{trial}{Trial number, from 1..NNN}
}

rubenarslan avatar Jul 10 '18 12:07 rubenarslan

I too have wondered if this exists. I have found any packages or solutions. 👍 codebook could a good package to include. Happy to discuss more.

DougManuel avatar Dec 21 '18 10:12 DougManuel

haven't looked into this any further. happy to merge a pull request if you want to take a stab at it. should be quite simple, but I havent' looked into writing rdoc at all so far.

rubenarslan avatar Dec 30 '18 16:12 rubenarslan