CHOP-CGTInformatics / REDCapTidieR

Makes it easy to read REDCap Projects into R

https://chop-cgtinformatics.github.io/REDCapTidieR/

Other

33 stars 8 forks source link

[FEATURE] Update Documentation for v0.4 Release #152

Closed rsh52 closed 1 year ago

rsh52 commented 1 year ago

Feature Request Description

Update documentation for add_skimr_metadata() and write_redcap_xlsx() once PR #151 is merged.

Glossary

[x] Add documentation for skimr and give its own entry in glossary
[x] Add entry for Data Access Groups to glossary, add DAG underneat Repeat Instrument/Event in top level table

README

[x] Update Usage section with a demo of for how to use write_redcap_xlsx() with screenshot of sample output. Additionally add "see vignette for more ifnromation on how to add labels and skimr to xlsx" type sentence

Getting Started Vignette

[x] After labels section, add a section about adding skimr

Diving Deeper Vignette

[x] Add a DAG section before the surveys one, structured similarly

Exporting to Excel Vignette

[x] Update vignette images from recent PR updates
[x] Add a sentence indicating write_redcap_xlsx() works with skimr as well (we already have labelled documentation)

Additional Context

Checklist

[x] The issue is atomic
[x] The issue description is documented
[x] The issue title describes the problem succinctly
[x] Developers are assigned to the issue
[x] Labels are assigned to the issue