Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Make the dyadMLM website and vignettes easier to find

Open
  • Is something wrong?
#23 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
markdown, r, yaml
Domain
documentation, search

Research direction

Start with _pkgdown.yml (homepage title/description) and the vignette sources: their YAML title/description fields plus each \VignetteIndexEntry{}. Check the plan in #25 first, since several checklist items are explicitly gated on its final page structure. Then update README/homepage links, docs/sitemap.xml, and submit it in Google Search Console. Done means live titles, descriptions, links and canonical URLs verified, the workshop present in the sitemap, and indexing requested with baseline results recorded.

Written by the indexing model from the issue text.

Description

documentation enhancement priority: medium

Goal

Help people find dyadMLM documentation for dyadic multilevel models and intensive longitudinal dyadic data in R. #25 covers README and vignette structure; #26 covers function help.

Remaining work

  • After #25, map each search topic to a final page. Follow its plan to remove Getting Started and redirect its URL. Avoid repeating intensive longitudinal guidance.
  • Update the homepage title and description in _pkgdown.yml, vignette titles and descriptions in YAML, and matching \VignetteIndexEntry{} fields. Identify dyadMLM as an R package. Mention cross-sectional and intensive longitudinal data, including daily-diary, ecological momentary assessment (EMA), and experience-sampling studies. Spell out intensive longitudinal in titles, headings, descriptions, and link text, and before using “ILD” in prose.
  • Give each page a clear purpose and opening description. APIM covers distinguishable and exchangeable dyads with glmmTMB; DIM covers exchangeable dyads and APIM–DIM equivalence; DSM covers distinguishable dyads, mean scores, and directional difference scores. Describe each vignette's cross-sectional and intensive longitudinal content. Keep the workshop's substantive title; improve its description if needed.
  • Link the README and homepage to the final preparation and model pages, including their intensive longitudinal sections. Link related vignettes using full model names. Keep short APIM, DIM, and DSM navigation labels; follow #25 for other navigation.
  • After publishing, check live titles, descriptions, links, and preferred (canonical) URLs. Add the workshop to sitemap.xml. After #25, check that the sitemap includes the homepage and final articles.
  • Submit the final sitemap in Google Search Console. Request indexing for the homepage, preparation and model pages, and workshop. Record initial results for the agreed search queries; review after 6–8 weeks.

Suggested titles, subject to #25's final page structure:

Page Title
Homepage dyadMLM: Dyadic Multilevel Models in R
APIM Actor–Partner Interdependence Model (APIM) in R
DIM Dyad–Individual Model (DIM) in R
DSM Dyadic Score Model (DSM) in R

Completed

  • Align wording across the personal homepage, pkgdown site, CITATION.cff, and Zenodo. Correct DIM to Dyad–Individual Model.
  • Explain in the README that dyadMLM prepares and checks data; packages such as glmmTMB and brms fit models.
  • Add dyadMLM to the UZH research-outputs page.
  • Replace outdated live documentation: the homepage shows 0.2.0.9000 (verified 2026-09-18).
  • Use the same main website URL in DESCRIPTION and _pkgdown.yml (verified 2026-09-18).
  • Include the homepage and four current vignettes in the sitemap (verified 2026-09-18).
  • Link to the workshop from navigation and README (verified 2026-09-18).

Track outreach separately: a LinkedIn or release post, R Weekly submission, MixedModels CRAN Task View request, and package slide with a QR code.

Dominant language
R
Stars
1
Forks
2
Avg merge
9h 28m
Merged PRs (30d)
21

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Pascal-Kueng/dyadMLM

All issues in Pascal-Kueng/dyadMLM

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.