rchive
rchive is the EDirect local-archive workhorse. The shell script in bin/ is only a platform dispatcher; it locates and execs a compiled binary such as rchive.Linux.
Quick Start
- Command:
rchive - Local wrapper:
/home/vimalinx/miniforge3/envs/bio/bin/rchive - Version path:
rchive -version
When To Use This Tool
- Creating Entrez index XML from PubMed/Entrez records (
-e2index) - Generating inverted indices for fast term searching (
-e2invert,-merge) - Building local record caches with optional gzip compression (
-archive,-gzip) - Querying indexed archives with Boolean formulas (
-query,-title,-exact)
Common Patterns
# 1) Inspect available archive/index flags
rchive --help
rchive -version
# 2) Create Entrez index XML from input records
cat records.xml | rchive -strict -e2index
# 3) Query an existing local postings directory
rchive -path /data/postings -query 'brca1 AND breast'
Recommended Workflow
- Decide whether you are archiving raw XML (
-archive/-fetch) or working on the index side (-e2index,-e2invert,-merge,-promote). - Verify the wrapper can find the platform binary with
rchive -versionbefore launching long archive jobs. - Feed valid XML from stdin or use
-inputwhen building indexes. - Separate archive storage, postings storage, and scratch space early because local-cache trees grow quickly.
Guardrails
rchive -versionprints a clean24.0, butrchive --versionis not equivalent; in local testing it fell through to a no-input error.- The wrapper script resets
PATHand then execs a platform-specific binary such asrchive.Linux; if that compiled binary is missing it prints download instructions instead of running. --helpproduced the full built-in help document in this environment, listing archive, index, query, and postings-management flags.- This is an operational local-archive tool, not a harmless inspector. Many flags create, merge, or delete cache/index artifacts.
- XML-consuming modes require real stdin or
-input; otherwise you can hitNo data supplied to rchive from stdin or file.