Add subheadings to long help sections
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- r
- Domain
- documentation
Research direction
Start with the roxygen blocks for recover_exchangeable_covariance() in R/model_exchangeable_covariance.R and the "Reading the plots" section of check_partner_dependence() in R/predictive_checks_dependence.R. Use the subheading example from #88 as a model, and add ## headings inside @details or @section without rewording. Regenerate the Rd files with roxygen2 (markdown = TRUE) and confirm the headings appear as \subsection{} in the generated man pages.
Written by the indexing model from the issue text.
Description
#88 adds subheadings to the section "People observed without their partner" in prepare_dyad_data(). Subheadings would make other long help sections easier to scan too, with no rewording. Related to #26.
-
R/model_exchangeable_covariance.R: Details ofrecover_exchangeable_covariance()(about 100 lines). Possible subheadings: Automatic matching, Custom block pairs, Equivalent term syntax, Checks of the difference indicator, People observed alone. -
R/predictive_checks_dependence.R: section "Reading the plots" ofcheck_partner_dependence()(about 50 lines). Possible subheadings: What the plots show, Reading differences and flags. The top-row and bottom-row panel lists would move up next to the first paragraph.
How: a ## heading inside @details or @section renders as \subsection{} (roxygen2 8.0.0 with markdown = TRUE).
- Dominant language
- R
- Stars
- 1
- Forks
- 2
- Avg merge
- 9h 28m
- Merged PRs (30d)
- 21
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Pascal-Kueng/dyadMLM
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Pascal-Kueng/dyadMLM#83 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Pascal-Kueng/dyadMLM#71 · 2 comments ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Pascal-Kueng/dyadMLM#70 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Pascal-Kueng/dyadMLM#69 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 84/100
Pascal-Kueng/dyadMLM#68 ·
Maintainers usually reply within 1 day
All issues in Pascal-Kueng/dyadMLM
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
mitchelloharawild/ggtime#39 ·
-
enhancement good first issue help wanted
Difficulty 2/5 Half a day Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
question
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Breaking 🏴☠️ Consistency :green_apple: :apple:
Difficulty 1/5 Under an hour Newbie friendliness 70/100
easystats/bayestestR#789 ·
Maintainers usually reply within 1 day