Contributing

Ethan O. Kile Timothy R. Brick

Open practices

All materials, code, and data behind WearITReadR and this standard are open source and publicly available at github.com/ymirssbm/wearitreadr.

A collaborative standard

Comprehensive codebook’s and data dictionaries for complex, adaptive study designs are still relatively rare. We think that’s mostly down to two causes: few guidelines currently exist describing documentation needs for adaptive/complex studies, and thorough documentation is costly. It takes real, ongoing time investment from research teams, often during the parts of a study (planning, analysis) when they’re busiest.

The Data Description Standard on this site, and the JSON Schema that implements it, are an initial attempt at addressing the first problem. WearITReadR itself is an attempt at the second.

Both are early and incomplete. We’d like to engage other researchers in open discussion of the standard described here, and welcome:

  • Feedback on the proposed metadata/paradata categories in Data Manuals
  • Proposed additions or changes to the JSON schema
  • New API translators for other data collection platforms (see WearITReadR for how the Qualtrics translator was built as a reference example)
  • Bug reports and feature requests for the Shiny app and R package

This site uses Just the Docs, a documentation theme for Jekyll.