archive-nmcds
Quick Start
- Command:
archive-nmcds [-index|-clean|-scrub|-scour|-erase|-zap] - Local executable:
/home/vimalinx/miniforge3/envs/bio/bin/archive-nmcds - Full reference: See
references/help.mdfor complete documentation
When To Use This Tool
- Build a local RefSeq NM mRNA/CDS archive for offline accession-driven sequence work.
- Generate the master accession list and CDS offset table that EDirect uses during local archive population.
- Refresh local RefSeq source records, then rebuild index and posting layers for offline lookups.
- Repair or reset broken archive state with the staged cleanup levels when a rebuild is required.
Common Patterns
# 1) Download RefSeq mRNA files and rebuild the local archive content
export EDIRECT_LOCAL_ARCHIVE=/data/edirect
archive-nmcds
# 2) Force HTTPS transfer instead of the default FTP / Aspera path
archive-nmcds -https
# 3) Rebuild incremental index, invert, merge, and postings layers
archive-nmcds -index
Recommended Workflow
- Set
EDIRECT_LOCAL_ARCHIVEand confirm the archive root is writable. - Ensure the supporting EDirect helper commands are present before starting a rebuild.
- Run
archive-nmcdsto stage source files, generate accession/CDS tables, and populate the archive. - Use
-indexas a separate follow-up step when you need refreshed search/posting structures. - Reach for
-clean,-scrub,-scour,-erase, or-zaponly when you truly need to tear down stale layers before rebuilding.
Guardrails
--helpand--versionare not metadata switches here; they still walk through setup, download, and generation code paths.- The script needs
EDIRECT_LOCAL_ARCHIVE,pm-setup, andpm-prepareto be available. - Cleanup levels are hierarchical and destructive:
-cleanremoves incremental/index state, while-zapremoves the source records and the remaining archive tree. - Cleaning and indexing must be separate invocations.
- Archive generation creates accession and CDS-offset side tables, so allow time and disk space beyond the raw downloads.