wgsim-eval-pl
Quick Start
- Command:
wgsim_eval.pl <command> [arguments] - Local executable:
/home/vimalinx/miniforge3/envs/bio/bin/wgsim_eval.pl - Reference: See references/help.md for detailed usage
When To Use This Tool
- Evaluate alignments or variant calls produced from
wgsim-simulated data. - Compare aligner accuracy on SAM files whose read names encode wgsim truth.
- Post-process SAM files to keep top-scoring hits before comparison.
- Compare two unique-hit alignment outputs from competing mapping workflows.
Common Patterns
# 1) Summarize mapping accuracy from a wgsim-derived SAM file
wgsim_eval.pl \
alneval \
simulated.sam
# 2) Emit ROC-style alignment evaluation output
wgsim_eval.pl \
alneval \
-a \
simulated.sam
# 3) Evaluate variant calls against wgsim SNP truth
wgsim_eval.pl \
vareval \
truth.wgsim.snp \
calls.pileup.flt
# 4) Keep only the top-scoring SAM hit per read before downstream comparison
wgsim_eval.pl \
unique \
alignments.sam
Recommended Workflow
- Decide which task you need:
alneval,vareval,unique, oruniqcmp. - Confirm the inputs really come from
wgsim-style simulations, because several subcommands depend on truth encoded in the read names or SNP truth files. - Run the chosen subcommand and capture the tabular output for downstream plotting or benchmarking.
- If necessary, use
uniquebeforealnevaloruniqcmpso multi-hit alignments are normalized consistently.
Guardrails
- The first argument must be a subcommand;
--helpand--versionare not recognized as top-level actions. alnevalanduniqueexpect SAM alignments whose read names were generated bywgsim; generic SAM files can produce warnings or meaningless accuracy numbers.varevalexpects awgsim.snptruth file plus a pileup-style variant call file.uniqueanduniqcmpare alignment post-processing/evaluation helpers, not generic SAM validation commands.