Skip to content

show the Preview button on every fixture - #1420

Merged
gaow merged 2 commits into
StatFunGen:mainfrom
jaempawi:docs/fixture-previews
Sep 2, 2026
Merged

show the Preview button on every fixture #1420
gaow merged 2 commits into
StatFunGen:mainfrom
jaempawi:docs/fixture-previews

Conversation

@jaempawi

@jaempawi jaempawi commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Most fixture rows showed only Download because 214 files across 37 modules were missing from FXWF, which controls which files appear for each workflow. Their previews mostly already existed.

Two commits, two files.

What changed

  • Added 214 missing FXWF keys across 37 modules.
  • Added 25 text-table previews.
  • Added summaries for five PLINK binary genotype files and one multicontext R object.
  • Documented one intentionally empty fixture.
  • Restored three ld_prune_reference files omitted by a glob.
  • Added dedicated plink and note preview kinds.

230 of 231 fixture paths now have previews. The only exception is a binary .tbi index with no readable content.

PLINK and empty-file handling

The builder now distinguishes text BED files from PLINK binary .bed files using the 6c 1b 01 magic bytes. Binary files receive summaries based on their accompanying .bim and .fam files instead of being rendered as text.

tests/fixtures/vcf_qc/expected/qc_2.variants.tsv remains empty intentionally: the test asserts that all records are filtered out. Its preview now explains that behavior.

Final preview counts: table 181, rds 43, plink 5, note 1.

Reviewer note

Most changed lines come from long embedded notebook data maps. The substantive changes are to FXWF, PREVIEWS, and two rendering branches.

Anak Empawi added 2 commits September 1, 2026 15:59
Most fixture rows showed only Download. The cause was FXWF, not PREVIEWS: it
filters which files appear per workflow, and 214 declared files across 37 modules
had no key, so they were hidden along with their Preview buttons. Previews already
existed for nearly all of them.

  - add the 214 missing FXWF keys
  - add 25 table previews for text fixtures that had none
  - add 5 summaries for PLINK binary genotypes: variant and sample counts read
    from the .bim and .fam, plus a few example rows. Reuses the existing rds kind
    so no rendering code changes.
  - add a summary for the multicontext QtlFineMappingResult
  - add a note for vcf_qc/expected/qc_2.variants.tsv explaining that the file is
    empty on purpose: GT-only variant QC removes every record on the toy data and
    test_qc_2 pins that outcome. Filling it would break the regression guard.
  - declare ld_prune_reference .bim, .fam and the .ld_genotype.list, which a glob
    in the previous commit had dropped

266 of 267 fixture rows now offer Preview. The one exception is a .tbi tabix
index, a binary offset table with nothing readable to show.
The PLINK genotype summaries added in the previous commit reused the rds preview
kind to avoid touching the render code, so a .bed opened under the heading
"R object preview" - wrong, and it read as though a table were missing.

Adds two preview kinds with their own headings:

  plink  PLINK binary genotype - not a text table
  note   File note

and retags the 5 PLINK genotypes and the one intentionally empty fixture. The 43
genuine .rds files keep the R heading.

Worth recording that .bed covers two unrelated formats: of the 17 .bed fixtures,
12 are text intervals and preview as tables, 5 are PLINK binary. Classification is
by the 6c 1b 01 magic bytes, since matching on the extension reads the binaries as
text and renders control characters.

230 of 231 fixture paths now have a preview; the exception is a .tbi tabix index.
@gaow
gaow merged commit 39ad10a into StatFunGen:main Sep 2, 2026
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants