Command line genome loading

From CoGepedia
Jump to: navigation, search

NOTE: You are probably looking for: Loading genomes from CoGe's web interface.

These instructions are for the command line driven software on CoGe's servers and are meant for the administrators of CoGe.

There are two general programs to run:

    • Loads in fasta sequences into CoGe
  • annotation loader:
    • usually some version of or some other program for loading text based gene models and annotations

UAGC Example

The UAGC produces many genomic sequences. This is to help them streamline their procedure for loading genomes into CoGe

  1. Get 454AllContigs.fna
    1. This is the usual contig-level genome assembly from the 454 genome sequencing pipeline

First, load the fasta sequence:

Note:Your fasta sequence headers will be used as the chromosome or contig (scaffold, superscaffold, etc) name. These are parsed to use the first set of all non-whitespace characters. (i.e. everything after the first space in a header name will not be used). Make sure that these "chromosome" names exactly match the ones used in the gene model/annotation file (e.g. GFF3). This is how gene models are matched to their associated chromosome of residence.

  1. run
~/projects/CoGeX/scripts/load_genomes_n_stuff/ \
-org_name "Acidovorax sp. strain JS42 substrain KSJ2" \
-org_desc "Bacteria;Proteobacteria;Betaproteobacteria;Burkholderiales;Comamonadaceae;Acidovorax;" \
-source_name "University of Arizona Genetics Core" \
-source_link "" \
-ds_version .1 \
-nt KSJ2_454AllContigs.fna \
-dsg_restricted 1

Important Notes

  • CoGe organisms genomes by a collection of datasets (often abbreviated as ds) into a dataset_group (abbreviated as dsg). The general idea is that a genome may consist of multiple files, and we want to track the provenance of each file. If you search for a genome/organism in OrganismView, you'll see that dsg is listed as "genome", but that there is an associated dsgid with each genome.

Option Descriptions

  • -org_name : the name of the organism
  • -org_desc : the GenBank taxanomic description of the organism
  • -source_name : the source of the data
  • -source_desc (optional) : description of the source of the data
  • -source_link (optional) : a http:// url to the the place that generated the data (or who owns the data)
  • -ds_version : version number for the genome
  • -ds_link (optional) : a http:// url to link to the place where the data file was downloaded
  • -nt : path to the nucleotide
  • -dsg_restricted (optional) : make this genome private

Additional Options

  • -org_id : if the organism is already entered into CoGe, you can use its internal CoGe ID (available by searching for the organism in OrganismView). This will automatically use the associated name and description.
  • -source_id : if the data source is already entered into CoGe, you can use its internal CoGe ID (available by searching for the organism in OrganismView). This will automatically use the associated name, description, and link.
  • -dsg_name (optional) : specify a name for the genome (dsg). If not used, will default to the name of the organism
  • -dsg_desc (optional) : specify a description for the genome (dsg).
  • -seq_type_id (optional) : specify a different type of sequence for the genome (e.g. masked). By default, unmasked is assumed. You can find a type associated with a genome in OrganismView. Don't fret if you don't know a seq_type_id. You can create a new one (below) or pick from this list of previously created types:
  • -seq_type_name (optional) : specify the name of a genomic sequence type
  • -seq_type_desc (optional) : specify the description of a genomic sequence type
  • -use_fasta_header (optional) : uses the entire fasta header line as the chromosome line (might be screwy when using a gene model/annotation file).
  • -chr (optional) : set chromosome name to something specific. Used for all sequences in the file (makes sense when there is only one sequence in the file).

After a fasta genome load:

Creating feature of type chromosome
Creating feature_name chromosome contig00315 for feat 81329038
Adding location contig00315:(1-70, 1)
Loading genomic sequence for chromosome: contig00316 (9 nt)
Working on chromosome contig00316 of type chromosome
Creating feature of type chromosome
Creating feature_name chromosome contig00316 for feat 81329039
Adding location contig00316:(1-9, 1)
     Formatdb running /usr/bin/formatdb -p F -o T -i /opt/apache/CoGe/data/genomic_sequence/0/0/11/11229/11229.faa
dataset_id: 46764
dataset_group_id: 11229

When is run, you'll see a stream of text letting you know that genomic features for chromosomes are being created in CoGe, and that names, locations, etc. are being specified for those genomic features. Note, that each chromosome is itself tracked as a genomic feature within CoGe. One set of these will be created for each chromosome (contig, etc.) loaded from you fasta file. When all sequences are loaded, this program will create the blastable databases for the sequence, and the final lines specify the dataset_id and dataset_group_id for the newly loaded genome. Save these numbers in your notes. You may need them in the future (but you can always search for them in OrganismView).

Syntenic path assembly

Often, you'll want to take a contig level assembly and generate a complete genome by comparison to a reference genome. CoGe has support for doing this AND printing out an assembled version of your genome. This assembled genome may be reloaded (as a higher version) using the method listed above. Follow this link for information on syntenic path assembly in CoGe.

Annotating the genome with Prodigal (from Oak Ridge National Labs)

Prodigal is a great program for quickly and easily identifying gene models in bacterial genomes. To annotate a genome using the program (e.g. one on which you just performed a syntenic path assembly), you may run:

prodigal -f gff < KSJ2_no-split-syntenic_path_assembly.fna > prodigal_models.gff

Loading gene models and annotation for a genome (well, in this case, a dataset)

Warning: There is quite a bit of heterogeneity in genome model and annotation formats; even within the same format (e.g. GFF3). Thus, there is not a one-use program in CoGe that works for all GFF3 files. However, there is a general program that is customized for each data source's example implementation of GFF3, and many such versions exist. Also, the program in CoGe for loading GFF3 data (, has become a bit like frankencode. Please feel free to contact Eric Lyons for any help/customizations, etc. Fortunately, once an institute has settled on a consistent format for GFF3 (or other file type), you can use the same program for all your genome loading needs. Once this program has been appropriately customized, it is very easy to run to load the annotations/gene models into CoGe:

./ -dsid 46765 -gff_file prodigal_models.gff

This will run the program, output all the actions it would perform, but not actually load the data into CoGe. To do the load, add -go 1 to the end of the command:

./ -dsid 46765 -gff_file prodigal_models.gff -go 1

Note: An example of the customization for is as follows for processing the GFF3 file produced from Prodigal:

  • No gene or mRNA models. These need to be created from the CDS models
  • Add Prodigal prediction to gene name and annotation

How to unscrewup

If you make a mistake and need to delete a genome you've loaded, just delete the whole genome (annotations and gene models included), and reload. To delete:

~/projects/CoGeX/scripts/ -dsgid 11230 -delete_seqs

Options for

  • -dsgid : which dataset_group (genome) to delete
  • -delete_seqs : delete the sequences from the sequence repository

NOTE: Make sure you get the dataset_group id (dsgid) correct!!! Otherwise, very bad things will happen. Fortunately, there are backups, but contact [1] immediately!