Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#172 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
r
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
R
Estrellas
23
Forks
6
Merge medio
2 d 9 h
PR fusionados (30 d)
12

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Merck/forestly

Todos los issues de Merck/forestly

Issues similares

Más issues de R

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.