DOKK / manpages / debian 10 / obitools / obiannotate.1.en
OBIANNOTATE(1) OBITools OBIANNOTATE(1)

obiannotate - description of obiannotate

obiannotate is the command that allows adding/modifying/removing annotation attributes attached to sequence records.

Once such attributes are added, they can be used by the other OBITools commands for filtering purposes or for statistics computing.

Example 1:

> obiannotate -S short:'len(sequence)<100' seq1.fasta > seq2.fasta


The above command adds an attribute named short which has a boolean value indicating whether the sequence length is less than 100bp.



Example 2:

> obiannotate --seq-rank seq1.fasta | \


  obiannotate -C --set-identifier '"'FungA'_%05d" % seq_rank' \


  > seq2.fasta


The above command adds a new attribute whose value is the sequence record entry number in the file. Then it clears all the sequence record attributes and sets the identifier to a string beginning with FungA_ followed by a suffix with 5 digits containing the sequence entry number.



Example 3:

> obiannotate -d my_ecopcr_database \


  --with-taxon-at-rank=genus seq1.fasta > seq2.fasta


The above command adds taxonomic information at the genus rank to the sequence records.



Example 4:

> obiannotate -S 'new_seq:str(sequence).replace("a","t")' \


  seq1.fasta | obiannotate --set-sequence new_seq > seq2.fasta


The overall aim of the above command is to edit the sequence object itself, by replacing all nucleotides a by nucleotides t. First, a new attribute named new_seq is created, which contains the modified sequence, and then the former sequence is replaced by the modified one.



Adds a new attribute named seq_rank to the sequence record indicating its entry number in the sequence file.

Changes attribute name <OLD_NAME> to <NEW_NAME>. When attribute named <OLD_NAME> is missing, the sequence record is skipped and the next one is examined.

Deletes attribute named <ATTRIBUTE_NAME>.When this attribute is missing, the sequence record is skipped and the next one is examined.

Creates a new attribute named with a key <KEY> and a value computed from <PYTHON_EXPRESSION>.

<FILENAME> points to a file containing attribute names and values to modify for specified sequence records.

Sets sequence record identifier with a value computed from <PYTHON_EXPRESSION>.

Runs a python expression on each selected sequence.

Changes the sequence itself with a value computed from <PYTHON_EXPRESSION>.

Sets sequence definition with a value computed from <PYTHON_EXPRESSION>.

Allows only valid python expressions.

Clears all attributes associated to the sequence records.

Keeps only attribute with key <KEY>. Several -k options can be combined.

Adds attribute with seq_length as a key and sequence length as a value.

Adds taxonomic annotation at taxonomic rank <RANK_NAME>.

Creates a new attribute containing the number of the cluster the sequence record was assigned to, as indicated in file <MCLFILE>.

Forces sequence record ids to be unique.

Regular expression pattern to be tested against the sequence itself. The pattern is case insensitive.


Examples:

> obigrep -s 'GAATTC' seq1.fasta > seq2.fasta


Selects only the sequence records that contain an EcoRI restriction site.

> obigrep -s 'A{10,}' seq1.fasta > seq2.fasta


Selects only the sequence records that contain a stretch of at least 10 A.

> obigrep -s '^[ACGT]+$' seq1.fasta > seq2.fasta


Selects only the sequence records that do not contain ambiguous nucleotides.




Regular expression pattern to be tested against the definition of the sequence record. The pattern is case sensitive.


Example:

> obigrep -D '[Cc]hloroplast' seq1.fasta > seq2.fasta


Selects only the sequence records whose definition contains chloroplast or Chloroplast.




Regular expression pattern to be tested against the identifier of the sequence record. The pattern is case sensitive.


Example:

> obigrep -I '^GH' seq1.fasta > seq2.fasta


Selects only the sequence records whose identifier begins with GH.




<FILENAME> points to a text file containing the list of sequence record identifiers to be selected. The file format consists in a single identifier per line.


Example:

> obigrep --id-list=my_id_list.txt seq1.fasta > seq2.fasta


Selects only the sequence records whose identifier is present in the my_id_list.txt file.





Regular expression pattern matched against the attributes of the sequence record. the value of this attribute is of the form : key:regular_pattern. The pattern is case sensitive. Several -a options can be used on the same command line and in this last case, the selected sequence records will match all constraints.


Example:

> obigrep -a 'family_name:Asteraceae' seq1.fasta > seq2.fasta


Selects the sequence records containing an attribute whose key is family_name and value is Asteraceae.




Selects sequence records having an attribute whose key = <KEY>.


Example:

> obigrep -A taxid seq1.fasta > seq2.fasta


Selects only the sequence records having a taxid attribute defined.




Python boolean expression to be evaluated for each sequence record. The attribute keys defined for each sequence record can be used in the expression as variable names. An extra variable named ‘sequence’ refers to the sequence record itself. Several -p options can be used on the same command line and in this last case, the selected sequence records will match all constraints.


Example:

>  obigrep -p '(forward_error<2) and (reverse_error<2)' \


   seq1.fasta > seq2.fasta


Selects only the sequence records whose forward_error and reverse_error attributes have a value smaller than two.




Keeps sequence records whose sequence length is equal or shorter than lmax.


Example:

> obigrep -L 100 seq1.fasta > seq2.fasta


Selects only the sequence records that have a sequence length equal or shorter than 100bp.




Selects sequence records whose sequence length is equal or longer than lmin.


Examples:

> obigrep -l 100 seq1.fasta > seq2.fasta


Selects only the sequence records that have a sequence length equal or longer than 100bp.




Inverts the sequence record selection.


Examples:

> obigrep -v -l 100 seq1.fasta > seq2.fasta


Selects only the sequence records that have a sequence length shorter than 100bp.




ecoPCR taxonomy Database name

NCBI Taxonomy dump repository name

select sequence with taxid tag containing a parent of rank <RANK_NAME>

required taxid

ignored taxid

The N first sequence records of the file are discarded from the analysis and not reported to the output file

Only the N next sequence records of the file are analyzed. The following sequences in the file are neither analyzed, neither reported to the output file. This option can be used conjointly with the –skip option.

Input file is in genbank format.

Input file is in embl format.

Input file is in fasta format (including OBITools fasta extensions).

Input file is in Sanger fastq format (standard fastq used by HiSeq/MiSeq sequencers).

Input file is in fastq format produced by Solexa (Ga IIx) sequencers.

Input file is in ecoPCR format.

Input is an ecoPCR database.

Input file contains nucleic sequences.

Input file contains protein sequences.

--fasta-output
Output sequences in OBITools fasta format

Output sequences in Sanger fastq format

--ecopcrdb-output=<PREFIX_FILENAME>
Creates an ecoPCR database from sequence records results

Print sequences in upper case (default is lower case)

Shows this help message and exits.

Sets logging in debug mode.

  • seq_length
  • seq_rank
  • cluster
  • scientific_name
  • taxid

  • rank
  • family
  • family_name
  • genus
  • genus_name

  • order
  • order_name
  • species
  • species_name




The OBITools Development Team - LECA

2019 - 2015, OBITool Development Team

January 28, 2019 1.02 12