AMAP(1)

πŸ“¦ version 2.2+git20080214.600fc29, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

okay bestie, welcome to the amap user manual πŸ¦‹ every single detail is in here, nothing got cut πŸ’…

✨ NAME ✨

amap β€” Protein multiple alignment by sequence annealing πŸ’–

✨ SYNOPSIS ✨

amap [OPTION] [MFAFILE] [MFAFILE]

✨ DESCRIPTION ✨

okay so AMAP is a tool for multiple alignment of peptidic sequences 🧬 and it does NOT do the traditional progressive alignment thing. instead it uses posterior decoding plus a sequence-annealing alignment πŸ”₯ it's giving main character energy.

it is literally the only alignment program that lets you control the sensitivity / specificity tradeoff πŸ‘‘ it's based on the ProbCons source code, but it uses alignment metric accuracy and gets rid of the consistency transformation πŸ’…

by default, AMAP is tuned to maximize the expected Alignment Metric Accuracy (AMA) score ✨ that's a newer accuracy measure built on a metric for the multiple-alignment space, and it squishes sensitivity and specificity into one balanced number 🌈 AMA is the fraction of correctly aligned residues (either to another residue or to a gap) out of the total number of residues in all the sequences. iconic math, no notes 🫢

amap takes sequences in MFA format πŸŽ€ an MFA file holds multiple sequences. each one starts with a single-line description, followed by lines of sequence data. the description line is easy to spot because it has a greater-than (>) symbol in the first column πŸ’œ


✨ OPTIONS ✨

  • -clustalw β€” switch to CLUSTALW output format instead of MFA πŸŽ€
  • -c, --consistency REPS β€” go with 0 <= REPS <= 5 (default: 0) passes of consistency transformation πŸ”₯
  • -ir, --iterative-refinement REPS β€” go with 0 <= REPS <=1000 (default: 0) passes of iterative-refinement 🌸
  • -pre, --pre-training REPS β€” go with 0 <= REPS <= 20 (default: 0) rounds of pretraining 🧚
  • -pairs β€” generate all-pairs pairwise alignments πŸ¦‹
  • -viterbi β€” use the Viterbi algorithm to generate all pairs (this automatically turns on -pairs for you ✨)
  • -v, --verbose β€” report progress while aligning (default: off) πŸ‘€
  • -annot FILENAME β€” write the annotation for the multiple alignment to FILENAME πŸ“
  • -t, --train FILENAME β€” compute EM transition probabilities and store them in FILENAME (default: no training) πŸ“
  • -e, --emissions β€” also reestimate emission probabilities (default: off) πŸ’…
  • -p, --paramfile FILENAME β€” read parameters from FILENAME (default: blank) 🫢
  • -a, --alignment-order β€” print sequences in alignment order instead of input order (default: off) 🌈
  • -g, --gap-factor GF β€” use GF as the gap-factor parameter. set it to 0 for best sensitivity, or go higher for better specificity (default: 0.5) ⭐
  • -w, --edge-weight-threshold W β€” stop the sequence annealing process when the best edge has a lower weight than W. set it to 0 for best sensitivity, or go higher for better specificity (default: 0) πŸ’«
  • -prog, --progressive β€” use progressive alignment instead of sequence annealing alignment (default: off) 🐒
  • -noreorder, --no-edge-reordering β€” disable reordering of edges during sequence annealing alignment (default: off) πŸ™…β€β™€οΈ
  • -maxstep, --use-max-stepsize β€” use the maximum improvement step size instead of tGf edge ranking (default: off) πŸ“
  • -print, --print-posteriors β€” only print the posterior probability matrices (default: off) πŸ–¨οΈ
  • -gui START STEP β€” print output for the AMAP Display Java based GUI (default: blank), starting at weight START (default: infinity) with step size STEP (default: blank) πŸͺ„

✨ EXAMPLES ✨

to run AMAP with the default options, change into the align directory and type:

% amap <multi-fasta-file-name>

if you don't give it a file name, it just prints the list of options πŸ“‹

if you want to use the AMAP Display, run AMAP with the -gui option, save the output to a file, then feed that file to AmapDisplay. like, for example, type:

% align/amap -gui examples/BB12020.tfa > examples/BB12020.tfa.out

% java -jar display/AmapDisplay.jar examples/BB12020.tfa.out

(on Debian systems, the examples directory is in /usr/share/doc/amap-align/examples πŸŽ€


✨ NOTE ✨

🚨 bestie, listen up: in older versions (< 2.0-1) of the package for Debian(TM) systems, the amap command got renamed to amap-align πŸ™ˆ because there was already another tool called amap (the one that does computer network diagnostics). a symbolic link called amap-align is still included for upgrades, but it's getting removed in Debian releases posterior to Etch (Debian 4.0). so don't get too attached πŸ’€

✨ SEE ALSO ✨

the current version of AMAP uses the PROBCONS 1.09 code base for some of the input/output procedures, and for calculating posterior probabilities (check PROBCONS.README in /usr/share/doc/amap-align/) πŸ“š future releases might build the algorithm on a new, independent code base ✨

on Debian(TM) systems, probcons(1) lives in the probcons package πŸ¦‹

✨ REFERENCES ✨

for more on AMAP and AMA, see Schwartz, Ariel S., Myers, Eugene W., and Pachter, Lior. Alignment Metric Accuracy (Submitted for publication). for more on sequence-annealing, see Schwartz, Ariel S. and Pachter, Lior. Multiple Alignment by Sequence Annealing (Submitted for publication) πŸ“–

PROBCONS was published in Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S. 2005. PROBCONS: Probabilistic Consistency-based Multiple Sequence Alignment. Genome Research 15: 330-340. 🧠

✨ AUTHORS ✨

  • Ariel Schwartz <sariel@cs.berkeley.edu> β€” upstream author of AMAP πŸ‘‘
  • Chuong Do β€” wrote Probcons, which AMAP is based on 🫢
  • Charles Plessy> <charles-debian-nospam@plessy.org> β€” wrote this manpage in DocBook XML for the Debian distribution 🌷

AMAP, PROBCONS, and this manual page have been made freely available as PUBLIC DOMAIN software, so they are not subject to copyright in the United States πŸ—½ you can use, modify, or redistribute this system and/or any portion of the source code without restrictions 🌈

BUT, and this part is important 😭 AMAP, PROBCONS and this manual page come WITHOUT WARRANTY, express or implied. the authors accept NO LEGAL LIABILITY OR RESPONSIBILITY for loss due to reliance on the program πŸ’€


okay that's the whole manual, bestie 🫢 amap 2.2, last updated 03/31/2008, AMAP(1) πŸ’– periodt πŸ’…πŸ¦‹