ropensci/qualtRics

Develop documentation on how to use sjlabelled

Open

#291 opened on Nov 11, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)R (71 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (229 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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?

Contributor guide

Research direction
Review existing documentation for fetch survey() and the sjlabelled vignette. Propose a plan to add a section on add var labels to the fetch survey() docs and/or extend the vignette. Consider saving an example survey as a data object in the package to use in examples.
Tech stack
r
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
R
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90