Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Consolidate vignettes: ~49-line metadata setup duplicated across 9 files

Aperta
  • Qualcosa non va?
#172 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
r
Ambito
documentation

Direzione di ricerca

Start with the eight customize-* vignette files and forestly.Rmd; compare their metadata setup blocks and identify the topic-specific sections to preserve. Read the vignette build configuration and the guidance for knitr child documents before choosing how to share the setup. Done means the setup has one source of truth, the customization topics are consolidated as proposed, and the vignettes still build.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Problem

The metadata-construction section is duplicated almost verbatim across the vignettes. Every customize-* vignette opens with an identical "Step 1: build your metadata" section — the full meta_adam() → define_plan() → define_population() → define_observation() → define_parameter() (×4) → meta_build() pipeline — before a short topic-specific "Step 2". forestly.Rmd builds the same metadata as well.

Evidence
  • 8 customize-* vignettes + forestly.Rmd = 9 copies of the same ~49-line setup.
  • The "Step 1" block is byte-identical across 6 of them; the other two (customize-ae-specific-columns, customize-listing-columns) differ only by offset / one stray blank line.
  • Each customize-* page contributes only ~40 genuinely unique lines (its "Step 2").

Any change to the example metadata API or data must currently be edited in 9 places, and the near-empty pages add navigation noise.

Proposal

Two complementary moves (either alone helps; together is best):

  1. Deduplicate the setup. Factor the metadata build into a single shared source — e.g. a _setup.Rmd pulled into each vignette via a knitr child= chunk, or a tiny exported example_meta() helper — so there is one source of truth for the example metadata.

  2. Merge the 8 customize-* pages into one "Customize the display" vignette with a section per topic (color, digits, x-limits, diff label, widths, SOC-only, toggle buttons, listing columns). They are all just ae_forestly() / format_ae_forestly() argument variations. Keep forestly.Rmd as the main end-to-end tutorial.

Option 1 removes all 9 duplicated copies; option 2 additionally collapses 8 thin pages into one cohesive, navigable article.

Notes

  • Coordinate with #171 (vignette self_contained fix) — both touch the same vignette YAML/structure, so it is natural to do them together.
Lingua principale
R
Stelle
23
Fork
6
Merge medio
2g 9h
PR unite (30g)
12

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Merck/forestly

Tutte le issue di Merck/forestly

Issue simili

Altre issue su R

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.