Get Help Documentation with Biopython

Q

How to Get Help Documentation with Biopython?

✍: FYIcenter.com

A

Biopython has help documentations built in the library. You can use the help() to read them.

Read help documentation on Biopython library.

fyicenter$ python
>>> import Bio
>>> help(Bio)

Help on package Bio:

NAME
  Bio - Collection of modules for dealing with biological data in Python.

DESCRIPTION
  The Biopython Project is an international association of developers
  of freely available Python tools for computational molecular biology.

  https://biopython.org

PACKAGE CONTENTS
  Affy (package)
  Align (package)
  AlignIO (package)
  Alphabet (package)
  Application (package)
  Blast (package)
  CAPS (package)
  Cluster (package)
  Compass (package)
  Data (package)
  Emboss (package)
  Entrez (package)
  ExPASy (package)
  File
  ...

CLASSES
  builtins.Exception(builtins.BaseException)
    MissingExternalDependencyError
      MissingPythonDependencyError(MissingExternalDependencyError, builtins.ImportError)
  builtins.ValueError(builtins.Exception)
    StreamModeError
  ...

Read help documentation on Biopython library.

>>> from Bio import SeqIO
>>> help(SeqIO)

Help on package Bio.SeqIO in Bio:

NAME
  Bio.SeqIO - Sequence input/output as SeqRecord objects.

DESCRIPTION
  Bio.SeqIO is also documented at SeqIO_ and by a whole chapter in our tutorial:
  
    - `HTML Tutorial`_
    - `PDF Tutorial`_
  
  .. _SeqIO: http://biopython.org/wiki/SeqIO
  .. _`HTML Tutorial`: http://biopython.org/DIST/docs/tutorial/Tutorial.html
  .. _`PDF Tutorial`: http://biopython.org/DIST/docs/tutorial/Tutorial.pdf
  
  Input
  -----
  The main function is Bio.SeqIO.parse(...) which takes an input file handle
  (or in recent versions of Biopython alternatively a filename as a string),
  and format string.  This returns an iterator giving SeqRecord objects:
  
  >>> from Bio import SeqIO
  >>> for record in SeqIO.parse("Fasta/f002", "fasta"):
  ...     print("%s %i" % (record.id, len(record)))
  gi|1348912|gb|G26680|G26680 633
  gi|1348917|gb|G26685|G26685 413
  gi|1592936|gb|G29385|G29385 471
  ...

 

Biopython for Sequence Motif Analysis

Pre-defined Sequence Alignment Score Settings

Biopython - Tools for Biological Computation

⇑⇑ OBF (Open Bioinformatics Foundation) Tools

2023-07-29, 307🔥, 0💬