Skip to content

Name the results tables and their columns files after what they hold - #11

Merged
emattei merged 2 commits into
mainfrom
fix/columns-yaml-names
Oct 15, 2026
Merged

emattei merged 2 commits into
mainfrom
fix/columns-yaml-names

Conversation

@emattei

@emattei emattei commented Oct 15, 2026

Copy link
Copy Markdown
Collaborator

Two renames, smallest first.

columns.yaml -> <table>_columns.yaml. A folder that holds one results
table also held a file called columns.yaml, so the name said nothing about
what it documented and two of them could not sit side by side.

The tables themselves. The folder names said which step ran; the file
names did not, and they disagreed on plural. Each table is now singular and
says what the guide was annotated against:

alignments/   guide_genome_annotation.tsv   guide_mapping.bed
              guide_genome_annotation_columns.yaml   qc.tsv
annotations/  guide_gene_annotation.tsv     guide_gene_annotation_columns.yaml
elements/     guide_element_mapping.tsv     guide_element_mapping_columns.yaml   qc.tsv
igvf/         guide_metadata.tsv            guide_metadata_columns.yaml

guide_metadata.tsv keeps its name: it is what the IGVF CRISPR Perturb-seq
pipeline reads, so the name is not ours to change.

This breaks every path a caller has written down, including the
--alignment argument of guide-annotation, element-mapping and
igvf-export. The failure is a clean missing-file error, not silent wrong
behaviour.

The alignment columns file still documents guide_mapping.bed alongside the
tsv, in one document, as it did before.

🤖 Generated with Claude Code

emattei and others added 2 commits October 15, 2026 08:47
A folder that holds one results table also held a file called columns.yaml,
so the name said nothing about what it documented and two of them could not
sit side by side. Each is now named for its table:

    alignments/guides_alignment_metadata_columns.yaml
    annotations/guides_gene_annotation_columns.yaml
    elements/guide_element_mapping_columns.yaml
    igvf/guide_metadata_columns.yaml

The alignment one still documents guides_mapping.bed alongside the tsv, in
one document, as it did before.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The folder names said which step ran; the file names did not, and they
disagreed on plural. Each table is now singular and says what the guide was
annotated against:

    guide_genome_annotation.tsv   (was guides_alignment_metadata.tsv)
    guide_gene_annotation.tsv     (was guides_gene_annotation.tsv)
    guide_element_mapping.tsv     unchanged
    guide_mapping.bed             (was guides_mapping.bed)

with each columns file following its table. guide_metadata.tsv keeps its
name: it is what the IGVF CRISPR Perturb-seq pipeline reads, so the name is
not ours to change.

This breaks every path a caller has written down, including the --alignment
argument of three commands.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@emattei
emattei merged commit ed5c9e3 into main Oct 15, 2026
9 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.

1 participant