archive-pids
Quick Start
- Command:
archive-pids [daily|-index] - Local executable:
/home/vimalinx/miniforge3/envs/bio/bin/archive-pids - Full reference: See references/help.md for complete documentation
When To Use This Tool
- Build a local postings archive for the PubMed
PMCIDfield. - Support offline PMID-to-PMCID style lookups inside a populated local EDirect archive.
- Refresh the PMCID posting data after PubMed metadata updates.
- Keep this identifier crosswalk in the same archive layout used by the rest of the PubMed local-data tools.
Common Patterns
# 1) Refresh the local PMCID postings archive
export EDIRECT_LOCAL_ARCHIVE=/data/edirect
archive-pids
# 2) Rebuild incremental index and invert layers after a refresh
archive-pids daily
# 3) Rebuild merged postings for downstream local queries
archive-pids -index
Recommended Workflow
- Set
EDIRECT_LOCAL_ARCHIVEand verify the target archive tree is writable. - Confirm
pm-setup,pm-prepare, and the local Go toolchain are available. - Run
archive-pidsto refresh the underlying PMCID data. - Follow with
dailyor-indexas a separate maintenance command when you need refreshed postings. - Check the timing summary before assuming the archive is ready for local identifier lookups.
Guardrails
--helpand--versionare not safe here; they still execute archive setup and prerequisite checks.- The script depends on
EDIRECT_LOCAL_ARCHIVE,pm-setup,pm-prepare, and a working localgocompiler. - Cleaning and indexing must be separate commands.
- Cleanup aliases remove local scratch content, so treat them as destructive maintenance.
- This tool is for building the local PMCID postings archive, not for extracting a one-off ID list from stdin.