Repository navigation
Name the results tables and their columns files after what they hold - #11
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two renames, smallest first.
columns.yaml-><table>_columns.yaml. A folder that holds one resultstable also held a file called
columns.yaml, so the name said nothing aboutwhat 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:
guide_metadata.tsvkeeps its name: it is what the IGVF CRISPR Perturb-seqpipeline reads, so the name is not ours to change.
This breaks every path a caller has written down, including the
--alignmentargument ofguide-annotation,element-mappingandigvf-export. The failure is a clean missing-file error, not silent wrongbehaviour.
The alignment columns file still documents
guide_mapping.bedalongside thetsv, in one document, as it did before.
🤖 Generated with Claude Code