Bio::T...:Domain(3pm)

πŸ“¦
version 1.7.3 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– NAME πŸ’–

Bio::Tools::HMMER::Domain β€” one particular domain hit from HMMER. Like, one domain. Singular. A whole little guy. πŸŽ€

This is a page from the User Contributed Perl Documentation, bestie, so pull up a chair.


✨ SYNOPSIS ✨

Read the Bio::Tools::HMMER::Results docs. That's it. That's the synopsis. The original really said "go read the other page" and honestly? Respect. πŸ’…


🌸 DESCRIPTION 🌸

Okay so. This thing is a particular domain score. That's its whole deal.

We reuse the Homol SeqFeature system here, so this object inherits off Homol SeqFeature. And because this code originally came from a separate project, there's some backward-compatibility stuff hanging around to keep old code working. Not our fault, we just live here. πŸ™ˆ

And don't forget β€” it also inherits off Bio::SeqFeature, so all your usual nice start/end/score stuff is ready for use. It's giving "I contain multitudes". πŸ”₯


πŸ“¬ CONTACT πŸ“¬

Ewan Birney, birney@ebi.ac.uk

🫢 CONTRIBUTORS 🫢

Jason Stajich, jason@bioperl.org


πŸ” APPENDIX πŸ”

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ β€” that's the tell, iykyk. πŸ‘‘

πŸ¦‹ add_alignment_line

  • Title: add_alignment_line
  • Usage: $domain->add_alignment_line($line_from_hmmer_output);
  • Function: add an alignment line to this Domain object
  • Returns: Nothing
  • Args: scalar

Adds an alignment line. Mostly this is here so we can store the HMMER alignments as flat text that can be regurgitated later. And yeah β€” you're right. This is not nice and not the right way to do it. C'est la vie. πŸ’€

πŸ¦‹ each_alignment_line

  • Title: each_alignment_line
  • Usage: foreach $line ( $domain->each_alignment_line )
  • Function: regurgitates the alignment lines as they were fed in. only useful realistically for printing.
  • Example: β€”
  • Returns: β€”
  • Args: None

πŸ¦‹ get_nse

  • Title: get_nse
  • Usage: $domain->get_nse()
  • Function: Provides a seqname/start-end format, useful for unique keys. nse stands for name-start-end. It is used a lot in Pfam.
  • Example: β€”
  • Returns: A string
  • Args: Optional separator 1 and separator 2 (default / and -)
Two separators, both optional, both with defaults. She's flexible. πŸ’…

πŸ¦‹ hmmacc

  • Title: hmmacc
  • Usage: $domain->hmmacc($newacc)
  • Function: set get for HMM accession number. This is placed in the homol feature of the HMM
  • Example: β€”
  • Returns: β€”
  • Args: β€”

πŸ¦‹ hmmname

  • Title: hmmname
  • Usage: $domain->hmmname($newname)
  • Function: set get for HMM accession number. This is placed in the homol feature of the HMM
  • Example: β€”
  • Returns: β€”
  • Args: β€”
Yes, hmmname's Function line says "accession number" too. We are faithfully reporting what the original says. Not a typo we invented, bestie, we just work here. 🌸

πŸ¦‹ bits

  • Title: bits
  • Usage: β€”
  • Function: backward compatibility. Same as score
  • Example: β€”
  • Returns: β€”
  • Args: β€”

πŸ¦‹ evalue

  • Title: evalue
  • Usage: β€”
  • Function: $domain->evalue($value);
  • Example: β€”
  • Returns: β€”
  • Args: β€”

πŸ¦‹ seqbits

  • Title: seqbits
  • Usage: β€”
  • Function: $domain->seqbits($value);
  • Example: β€”
  • Returns: β€”
  • Args: β€”

πŸ¦‹ seq_range

  • Title: seq_range
  • Usage: β€”
  • Function: Throws an exception to catch scripts which need to upgrade
  • Example: β€”
  • Returns: β€”
  • Args: β€”

πŸ¦‹ hmm_range

  • Title: hmm_range
  • Usage: β€”
  • Function: Throws an exception to catch scripts which need to upgrade
  • Example: β€”
  • Returns: β€”
  • Args: β€”
⚠️ Both seq_range and hmm_range are deliberately explosive β€” they exist to throw so your old script gets caught and you go upgrade it. That's the point. Don't come crying to me when it yells at you. 😭

perl v5.30.0 Β· 2019-10-29

And that's the whole page, bestie β€” this one's from perl v5.30.0, dated 2019-10-29, and it ate, no notes. Go read Bio::Tools::HMMER::Results like the synopsis told you to. πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from