Consolidate vignettes: ~49-line metadata setup duplicated across 9 files
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- r
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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):
-
Deduplicate the setup. Factor the metadata build into a single shared source — e.g. a
_setup.Rmdpulled into each vignette via a knitrchild=chunk, or a tiny exportedexample_meta()helper — so there is one source of truth for the example metadata. -
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 justae_forestly()/format_ae_forestly()argument variations. Keepforestly.Rmdas 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_containedfix) — both touch the same vignette YAML/structure, so it is natural to do them together.
- 主要言語
- R
- スター
- 23
- フォーク
- 6
- 平均マージ
- 2日 11時間
- マージ済み PR（30日）
- 13
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Merck/forestly のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 2 日以内に返信
-
Add `ae_listing_placebo` to control placebo-subject drill-down in AE forest plots対応中かも @LittleBeannie が 2 日前に担当しました。 オープン
Merck/forestly#174 · 担当者 1 名 ·
メンテナーはふだん 2 日以内に返信
-
Correct the misspelled `dowload_button` argument in ae_forestly()?対応中かも @yihui が 5 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
Merck/forestly#173 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
Allow numerical filtering for percentages対応中かも @yihui が 10 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
Merck/forestly#166 · コメント 1 件 · 担当者 1 名 ·
メンテナーはふだん 2 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 65/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 62/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
lrberge/fixest#686 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
-
ai-discovered area: data explorer
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
posit-dev/positron#16530 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信