jacob-long / jacob-long/interactions

Missing documentation of the meaning of errorbars in cat_plot

Open
#82 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
R
Stars
135
Forks
19
PR merge metrics
No merged PRs in 30d

Description

Greetings!

When using cat_plot, I failed to understand the meaning of the errorbars. Depending on the field (mine is psychology) it might not be obvious what errorbars should represent (SE, SD, 95% CI, 99% CI, ...). Even from looking into the function's code it is not obvious how the errorbars are computed. It would be very useful to have a comment on that in the package documentation.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the cat_plot documentation and the function implementation referenced in the issue. Read how the errorbars are computed, then document which quantity they represent and add the explanation to the package documentation; done means users can distinguish the errorbars from SE, SD, and confidence intervals.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.