Skip to main content

Synopsis

hhconsensus -i <file> [options]

Description

HHconsensus calculates the consensus sequence for an A3M/FASTA input file.

Required Parameters

-i
file
required
Query alignment (A2M, A3M, or FASTA), or query HMM

Output Options

-s
file
Append consensus sequence in FASTA format (default: <infile.seq>)
-o
file
Write alignment with consensus sequence in A3M format
-oa3m
file
Write alignment with consensus sequence in A3M format (same as -o)
-oa2m
file
Write alignment with consensus sequence in A2M format
-ofas
file
Write alignment with consensus sequence in FASTA format
-v
integer
default:"2"
Verbose mode:
  • 0: no screen output
  • 1: only warnings
  • 2: verbose

Filter Input Alignment

-id
integer
default:"100"
Maximum pairwise sequence identity (%) (range: 0-100)
-diff
integer
default:"0"
Filter most diverse set of sequences, keeping at least this many sequences in each block of >50 columns
-cov
integer
default:"0"
Minimum coverage with query (%) (range: 0-100)
-qid
integer
default:"0"
Minimum sequence identity with query (%) (range: 0-100)
-qsc
float
default:"-20.0"
Minimum score per column with query

Input Alignment Format

-M
string
default:"a2m"
Input alignment format:
  • a2m or a3m: upper case = Match; lower case = Insert; ’-’ = Delete; ’.’ = gaps aligned to inserts
  • first: FASTA format where columns with residue in 1st sequence are match states
  • [0-100]: FASTA format where columns with fewer than X% gaps are match states

Other Options

-maxseq
integer
default:"65535"
Max number of input rows
-maxres
integer
default:"20000"
Max number of HMM columns

Examples

Generate consensus sequence

hhconsensus -i stdin -s stdout

Create consensus with alignment output

hhconsensus -i alignment.a3m -s consensus.seq -oa3m output.a3m

Exit Codes

  • 0: Success
  • 1: File format error
  • 2: File access error
  • 3: Memory error
  • 4: Command line error

See Also

Build docs developers (and LLMs) love