Skip to content

Revise the REF_PATH / REF_CACHE documentation.#2178

Merged
daviesrob merged 3 commits into
samtools:developfrom
jkbonfield:no-ebi-ref
May 19, 2025
Merged

Revise the REF_PATH / REF_CACHE documentation.#2178
daviesrob merged 3 commits into
samtools:developfrom
jkbonfield:no-ebi-ref

Conversation

@jkbonfield

Copy link
Copy Markdown
Contributor

Updates to reflect the changes in the htslib/no-ebi-ref PR.

Also moved the section listing the reference discovery ordering to be adjacent to the environment variable section so all relevant text is together.

@daviesrob daviesrob self-assigned this Jan 30, 2025
@jkbonfield

jkbonfield commented May 15, 2025

Copy link
Copy Markdown
Contributor Author

For @daviesrob: one thing you may wish to replace is "If that is done, it is strongly encouraged you also specify a local REF_CACHE
directory" with wording appropriate for your new ref-cache tool. IMO using that is preferable over using REF_CACHE now. If so, I'll leave it to you to decide how to phrase it.

The bit about reference sequences and CRAM is incorrect in saying CRAM requires a reference, but I didn't change that text - only punted it lower down in the document. I don't think it's worth getting overly worried about that though as it's how 99.something% of CRAMs are produced. While I think on-the-fly embedded consensus refs are a better solution for many people, they're not really well supported by the archives (I think) and until that happens people will just go with the standard workflow.

jkbonfield and others added 2 commits May 19, 2025 14:46
Updates to reflect the changes in the htslib/no-ebi-ref PR.

Also moved the section listing the reference discovery ordering to be
adjacent to the environment variable section so all relevant text is
together.
@daviesrob

Copy link
Copy Markdown
Member

Text has been adjusted as requested. Also rebased to avoid unrelated problems with testing that would otherwise occur.

@daviesrob daviesrob merged commit f023cb9 into samtools:develop May 19, 2025
daviesrob added a commit to whitwham/samtools that referenced this pull request May 20, 2025
Ensure it's clear which sub-commands are being referenced

Add items for PRs samtools#2178 and samtools#2222

Adjust wording for a couple of items and fix a few typos.
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