ropensci / qualtRics

Download ⬇️ Qualtrics survey data directly into R!
https://docs.ropensci.org/qualtRics
Other
216 stars 70 forks source link

Develop documentation on how to use sjlabelled #291

Open juliasilge opened 2 years ago

juliasilge commented 2 years ago

Related to #290

The qualtRics package adds labels to surveys that can be used with sjlabelled but we don't surface this very clearly. How can we better communicate this to folks? We could:

A challenge here is that none of the documentation actually queries Qualtrics live so we can't easily show the output anywhere. One option would be to save an example survey (output of fetch_survey()) as a data object in the package to use in examples and vignettes?

jmobrien commented 2 years ago

+1 to this, though I agree we should think about what's best to include.

Re: implementation, seems like a saved example survey would work fine; the vignette could just use read_survey() on it. (Maybe vcr could work, too, but I don't think we'd need to get that fancy)