AuReMe documentation

How to use the AuReMe workspace (default workflow)

AuReme is deployed in a Docker image. Thanks to this Docker image, all the tools inside the AuReMe workspace are ready to use inside the AuReMe container.

Requirements

  1. Create your Docker container as explained in the previous step Running a Docker container, start the container and go inside.

Start a new study

  1. Use the following command to start a new study. Choose an identifier for this study (ex: replace species by your organism name). In order to illustrate this documentation, we will use species as a run identifier.
aureme> aureme --init=species

Now you will find on your own computer (host), in your bridge directory, a folder species with many subdirectory and files. This is your work directory, on which AuReMe is going to run.

Note

Notice that by default all the outputs of commands will be printed in the terminal. Nevertheless, if you want to trace all your commands just type:

aureme> aureme --run=species --cmd="some_command" -q

Thanks to the quiet option, the command will be stored as a log in the bridge > species > log.txt file. The output of this command will also be stored in the bridge > species > full_log.txt file.

For further details on the log files, please see the How to manage the log files? chapter.

  1. To get an overview of AuReMe, you can get a sample by using this command.

    aureme> aureme --run=species --sample
    

Define the reference database

  1. The final step is to define which reference database to use. The available databases are listed in your terminal when you create a new study. If needed, use this command to display them again.

    aureme> aureme --run=species --cmd="getdb"
    Running command: getdb in species
    Available database in Aureme:
    /home/data/database/MODELSEED/modelSeed
    /home/data/database/BIGG/bigg
    /home/data/database/BIOCYC/METACYC/23.0/metacyc_23.0
    
This reference database is needed to:
  • Be able to match all the identifiers of the entities of metabolic networks.
  • Gap-fill the metabolic network in the gap-filling step.
  • Uniforms the data in one unique database.

To select one of the above databases, replace the corresponding path in the configuration file: config.txt, in the DATA_BASE variable, or comment the line if you don’t want/can’t use a database.

The config.txt file is stored at the root of your species folder.

The default workflow

By default, the AuReMe workspace includes an automatic workflow for metabolic network reconstruction. This workflow runs several pre-installed tools and generates diverse output files. The process can be either run entirely in a single command, or run step by step to personalize it or do some intermediary analysis.

For instance, if you run the draft command (see Merge metabolic networks), it will run all the previous steps automatically as described in the following figure. This figure details the steps of the default workflow.

Structure of the AuReMe default workflow

Data organization

Bridge structure

The bridge directory will store all your input data you will provide, and all the result files the workflow is going to create. In this section, all the bridge sub-directories will be described.

analysis: All output files of the analysis processes.
annotation_based_reconstruction: If you want to use
annotated genomes (to run the annotation-based recons-
truction part of the workflow), put here all the output
files of the annotation tool. For instance with
Tools, copy-paste the whole PGDB
database: If you want to use your own database put in
this folder your database in Padmet format, if you have a
SBML convert this file to Padmet (see
to update the config.txt file after transforming your
database into the Padmet format.
gapfilling/original_output: If you run the metabolic
network reconstruction with gap-filling, will contain all
the output files of gap-filling tools before any post-
process from AuReMe (see the Gap-filling section).
genomic-data: The directory in which to put the
genomic data on your studied organism, that is to say
either a Genbank (species.gbk) or a proteome
(species.faa).
growth_medium: Description of the set of metabolites
that is available to initiate the metabolism (growth me-
dium), that is to say the seed compounds (seeds.txt
and artefacts.txt), see How to manage growth medium?
growth_medium: Description of the set of metabolites
that is available to initiate the metabolism (growth me-
dium), that is to say the seed compounds (seeds.txt
and artefacts.txt), see How to manage growth medium?

manual_curation: All the files to describe the manual
curation you want to apply on your metabolic network
(either adding, deleting or modifying reactions), see

networks: All the metabolic networks used or created
during the reconstruction process.
networks > external_network: Put here all existing
metabolic networks (.sbml) you want to use. Enables to
merge them with the ones created thanks to other me-
thods (see the Merge metabolic networks section).
networks > output_annotation_based_reconstruction:
Will contain the processed network from the annotation
based reconstruction, after the pre-processing of the
data from the annotation_based_reconstruction
directory (if you filled this one).
networks > output_orthology_based_reconstruction:
Will contain the processed network from the orthology
based reconstruction, after the pre-processing of the
data from the orthology_based_reconstruction
Bridge directory content
directory (if you have run this
part of the workflow).
orthology_based_reconstruc
tion: If you want to use model
organims (to run orthology-based
reconstruction part of the work-
flow), put in this directory, a
subdirectory named species the
proteome (species.faa or
species.gbk) and the metabolic
network (species.sbml) of your
model (see below
for more details).
targets_compounds: Description
of the set target compounds
(targets.txt), that is to say
metabolites whose production is
supposed to be achieved by the
metabolism of the species under
study (components of the biomass
reaction or orther metabolites),
see the Gap-filling
paragraph.

Provide input files

First of all, you have to provide to AuReMe all the input files needed for the different steps you want to run in the workflow. The steps can be optional or run several times, at different phases of the process. However, you have to store the input data for each steps, observing the architecture described above for the bridge directory (see Bridge structure section).

Here is the list of inputs you have to provide to run the pre-set default workflow. If you want to run only part of it, please see the corresponding sections and the chapter How to create a new ‘à-la-carte’ workflow?

  • See Orthology-based inputs.

  • See Annotation-based inputs.

  • External source for reconstruction If you already have one or several external metabolic networks for your studied species and you want to improve them, just copy-paste them (SBML format) in the networks > external_network folder.

    /species
      |-- networks
          |-- external_network
              |-- first_manual_network.sbml
              |-- second_manual_network.sbml
              |-- ...
    

Check input files validity

This will verify the format and consistency of your data for a
better quality result. Moreover, it will generate all the
supplementary files needed by the workflow tools and put them
into the corresponding folders. For more information about
input files validity see What is checked in my input files?
Check inputs

For this purpose, use this command:

aureme> aureme --run=species --cmd="check_input"

Warning

Always check the validity of the inputs before running any workflow task, and after having put every input files needed for the steps of the workflow.

Orthology-based reconstruction

Method: OrthoFinder

Input files
Required for the orthology-based reconstruction (method:
OrthoFinder):
* Genbank or Proteome of your studied organism (.gbk or .faa)
* Genbank or Proteome of your reference organism (.gbk or .faa)
* Metabolic network of your reference organism (.sbml)
* (option) a dictionary file if genes ids used in metabolic
network are different with GBK/FAA (.txt)
Result files
OrthoFinder input/output files
Orthology method in Aureme

Orthology-based inputs

  1. Put all the available genomic data of the studied organism in the folder genomic_data, either a Genbank (.gbk) or a Fasta (.faa) file. Please give to these files the same name the bridge directory has. Here, the bridge directory is named “species”, so these files will respectively named “species.faa” or “species.gbk”.

  2. For each reference organism you want to use, create a subdirectory in the directory orthology_based_reconstruction. Give it the name of your model organism (e.g. model_a). On a Linux operating system, here is the above command to create a new folder named model_a.

    shell> mkdir orthology_based_reconstruction/model_a
    
  3. In each folder, put:

    • the Genbank file of your model organism, with the same name than its directory, (here model_a.gbk) OR the proteome of your model organism, with the same name than its directory (here model_a.faa),

    • the metabolic network of your model organism, with the same name than its directory (here model_a.sbml).

      /species
        |-- orthology_based_reconstruction
             |-- model_a
                  |-- model_a.gbk or model_a.faa
                  |-- model_a.sbml
                  |-- dict_genes.txt (option)
      
  4. The genome (or proteome) and the metabolic network of your model organism have to contain the same kind genes (or proteins) identifiers to be comparable. If not enough genes (or proteins) are in common between the two files, the process will stop to avoid poor quality data production.

    If you want to pursue on the process, please provide a dictionary file between the gene (or protein) identifiers of these two files. Name this dictionary dict_genes.txt. Here is the dictionary file format asked (tabulation separated values):

    gene_id_from_sbml1\tgene_id_from_faaA
    gene_id_from_sbml2\tgene_id_from_faaB
    gene_id_from_sbml3\tgene_id_from_faaC

Orthology-based run

Warning

Remember to check the validity of the inputs before running any workflow task.

  1. If you want to run only the orthology-based reconstruction, use now this command:

    aureme> aureme --run=species --cmd="check_input"
    
  2. To run only the orthology-based reconstruction, use this command:

    aureme> aureme --run=species --cmd="orthology_based"
    
  3. Use this command, to get the database of a given metabolic network:

    aureme> aureme --run=species --cmd="which_db SBML=output_orthofinder_from_model_a.sbml"
    

Warning

Because the metabolic network from the reference organism could come from different databases, it’s critical to check the database of each network and if needed convert the network to your reference database selected (see How to use the AuReMe workspace (default workflow) and Define the reference database).

The previous command will check the database of the file output_orthofinder_from_model_a.sbml, if the database is different for the reference, use the next command to create a mapping file to the reference database. For more information about SBML mapping see How to map a metabolic network on another database?

aureme> aureme --run=species --cmd="sbml_mapping SBML=output_orthofinder_from_model_a.sbml DB=METACYC"

Annotation-based reconstruction

Method: Pathway Tools

Input files
Required for the annotation-based reconstruction (method:
Pathway Tools):
* The output of Pathway tools (PGDB folder)
Result files
Pathway-tools output files
Annotation method in Aureme

Annotation-based inputs

  1. Put the output of Pathway Tools (the whole PGDB directory) in the folder annotation_based_reconstruction.

    /species
      |-- annotation_based_reconstruction
          |-- genome_a (you can change the name of the folder)
              |-- compounds.dat
              |-- enzrxns.dat
              |-- genes.dat
              |-- pathways.dat
              |-- proteins.dat
              |-- reactions.dat
    
  2. The above cited files are required in order to run the Annotation-based reconstruction. If you have run several times Pathway Tools and want to use all of these annotations, just copy-paste the other PGDB folders in the annotation_based_reconstruction directory.

Annotation-based run

  1. If you want to run only the annotation-based reconstruction, use now this command:

    aureme> aureme --run=species --cmd="check_input"
    

Warning

Remember to check the validity of the inputs before running any workflow task.

  1. To run only the annotation-based reconstruction, use this command.

    aureme> aureme --run=species --cmd="annotation_based"
    

Merge metabolic networks

Input files
Metabolic networks in the networks directory.
Result file
Merging output file
Merging method in Aureme

To merge all available networks in the the annotation_based_reconstruction directory, together with those are in the networks directory, and in all its subdirectories, into only one metabolic network. To merge all data on the studied species, run this command:

aureme> aureme --run=species --cmd="draft"

Note

You can also add external metabolic network to create the draft (see Data organization).

Warning

Before merging your networks, check if not already done if all the SBML are using the reference database, see How to map a metabolic network on another database? Also check the compartment ids used in each of them, delete and change compartment if need.

For example: if a SBML is using KEGG database but your reference database is Metacyc, you will have to map this SBML to create a mapping file which will be used automatically in the merging process.

Gap-filling

Method: Meneco

Input files
Required for the gap-filling (method: Meneco):
* A metabolic network reference database (.padmet or .sbml)
(Metacyc 23.0, BIGG and ModelSeed are available by default)
* Seed and target metabolites (.txt)
* A metabolic network to fill (typically created during the
previous steps).
Result files
Meneco output files
Gap-filling method in Aureme

Gap-filling input

  1. You must have selected a reference database to fill-in the potential gaps in the metabolic network. If it is not done yet, please see Define the reference database.

  2. Put the seeds file (named seeds.txt) in the growth_medium folder. The seed compounds are the description of the set of metabolites that is available to initiate the metabolism (growth medium). Put also the artefacs file (named artefacts.txt) in the growth_medium folder. The artefacts file has the same format as the seeds file. Here, artefacts are metabolites allow Meneco to initiate cycles in in a metabolic network (report to What are “artefacts”? section). Here is as example of the seed file format:

    seed_name_compound_id1\tcompartment1
    seed_name_compound_id2\tcompartment2
    seed_name_compound_id3\tcompartment3
  3. Set the growth medium using this command:

    aureme> aureme --run=species --cmd="set_medium NETWORK=network_name NEW_NETWORK=new_network_name"
    

For more details on the medium settings, see How to manage growth medium?

Warning

If you don’t precise any NEW_NETWORK name, the current network will be overwritten.

  1. Put the target file (named targets.txt) in the targets_compounds folder. The targets are metabolites whose production is supposed to be achieved by the metabolism of the species under study (components of the biomass reactions or other metabolites). Here is as example of the target file format:

    target_name_compound_id1\tcompartment1
    target_name_compound_id2\tcompartment2
    target_name_compound_id3\tcompartment3
  2. You will have to indicate which metabolic network you want to gap-fill with the Meneco software. If you want to gap-fill a network created in the previous steps, there is nothing to do. Otherwise, put the network you want to gap-fill (Padmet format) in the networks directory.

    The input files which are needed to run the gap-filling with AuReMe.

Gap-filling run

  1. (optional step) To generate the gap-filling solution run this command:

    aureme> aureme --run=species --cmd="gap_filling_solution NETWORK=network_name"
    

Note

Do not forget the quotation marks.

It will calculate the gap-filling solution on the network_name network (in the networks directory) and put it into the gapfilling directory as gapfilling_solution_network_name.csv.

  1. To generate the gap-filled network (and run step 6), run this command:

    aureme> aureme --run=species --cmd="gap-filling NETWORK=network_name NEW_NETWORK=new_network_name"
    

Note

Do not forget the quotation marks.

It will calculate the gap-filling solution (if it is not yet done) on the network_name network (in the networks directory) and put it into the gapfilling directory. Then it will generate the metabolic network (new_network_name), completed with the gap-filling solution, in the networks directory.

Note

You can first generate the solution, modify it, then generate the gap-filled network.

Warning

If you don’t precise any NEW_NETWORK name, the current network will be overwritten.

Manual curation

This step can be done several times and at any moment of the workflow.

  1. Describe the manual curation(s) you want to apply by filling the corresponding form(s) as explained below.

Warning

It is highly recommanded to create a new form file (.csv) each time you want to apply other changes, in order to keep tracks of them.

Add a reaction from the database or delete a reaction in a network

  1. Copy from the folder manual_curation > template the file reaction_to_add_delete.csv and paste it into the manual_curation directory (this way on Linux operating systems):

    aureme> cp manual_curation/template/reaction_to_add_delete.csv manual_curation/my_create_form.csv
    
  2. Fill this file (follow the exemple in the template).

    idRef        Comment                                Action   Genes
    my_rxn       Reaction deleted because of x reason   delete
    RXN-12204    Reaction added because of x reason     add      (gene1 or gene2)
    RXN-12213    Reaction added because of x reason     add      gene18
    RXN-12224    Reaction added because of x reason     add
    

Create new reaction(s) to add in a network

  1. Copy from the folder manual_curation > template the file reaction_creator.csv and paste it into the manual_curation directory (this way on Linux operating systems):

    aureme> cp manual_curation/template/reaction_creator.csv manual_curation/my_create_form.csv
    
  2. Fill this file (follow the exemple in the template).

    reaction_id        my_rxn
    comment            reaction added because of X reason
    reversible         false
    linked_gene        (gene_a or gene_b) and gene_c
    #reactant/product  #stoichio:compound_id:compart
    reactant           1.0:compound_a:c
    reactant           2.0:compound_b:c
    product            1.0:compound_c:c
    
    reaction_id        my_rxn_2
    comment            reaction added because of X reason
    reversible         true
    linked_gene
    #reactant/product  #stoichio:compound_id:compart
    reactant           1.0:compound_a:c
    reactant           2.0:compound_d:c
    product            1.0:compound_c:c
    product            1.0:compound_d:c
    

Apply changes

  1. To apply the changes described in the my_form_file.csv form file, run this command:

    aureme> aureme --run=species --cmd="curation NETWORK=network_name NEW_NETWORK=new_network_name DATA=my_form_file.csv"
    

    Warning

    If you don’t precise any NEW_NETWORK name, the current network will be overwritten.