-
Notifications
You must be signed in to change notification settings - Fork 2
Example GLUE Project

In GLUE, a project is a self-contained package containing data and analysis functions related to a specific set of virus sequences. This example project, based on Hepatitis E Virus (HEV), illustrates many of GLUE's key features.
HEV is an important cause of viral hepatitis, primarily transmitted through the fecal-oral route, especially in regions with inadequate sanitation. It is a member of the Hepeviridae family and has four main genotypes, with genotypes 1 and 2 typically associated with outbreaks in developing countries, while genotypes 3 and 4 are linked to zoonotic transmission in developed countries.
Symptoms of HEV infection include fatigue, jaundice, abdominal pain, and loss of appetite, with most cases resolving spontaneously. However, the virus can lead to severe complications, particularly in pregnant women, and chronic infection may occur in immunocompromised individuals.
GLUE projects conventionally store their files in dedicated directories inside the gluetools/projects
directory.
Note
If you are using Docker-based GLUE, the example project is already unzipped in your container filesystem. Skip to Build the Project.
If you are using Native GLUE, download the example project zip file from the GLUE Download Page and unzip it into gluetools/projects
.
$ cd /home/fred/gluetools/projects
$ unzip exampleProject-1.1.113.zip
Start an interactive GLUE session within the exampleProject
directory:
$ cd /home/fred/gluetools/projects/exampleProject
$ gluetools.sh
In GLUE, a project is archived as a set of files. To use it, you must build the project, which involves running commands to load project data and analysis configurations into the database.
- Start a GLUE interactive session.
- Execute the
run file
command on the fileexampleProject.glue
, which serves as the master build file.
GLUE version 1.1.113
Mode path: /
GLUE> run file exampleProject.glue
...
- If the build reports errors (e.g., with BLAST+, MAFFT, or RAxML integrations), check the installation instructions.
- If unresolved, raise a question on the GLUE Support Forum.
A successful build ends with the output:
...
OK
Mode path: /
GLUE>
After building, the project becomes a basic resource for storing and analyzing HEV sequences. Key elements include:
-
Sequences: GenBank XML sequences are stored in
ncbi-refseqs
. This includes sequence L08816, used to define genome feature locations. -
Reference Sequences:
ncbi-refseqs
are designated ReferenceSequences as per Smith et al., 2016. -
Genome Features: Includes three ORFs and seven sub-domains of ORF1. Features from L08816 are transferred to other references via the
inherit feature-location
command. - Alignment: Sequences are stored in an unconstrained alignment.
- Constrained Alignments: Defined for HEV genotypes and subtypes, based on ReferenceSequences.
- Alignment Tree: Links constrained alignments, with internal node homologies derived from the unconstrained alignment.
- Phylogenetic Tree: Generated using RAxML and imported into the alignment tree.
- Clade Assignment: Maximum-likelihood Clade Assignment modules allow genotype and subtype identification.
- Metadata Fields: Extensions include sequence length, collection year, host species, and country of origin (based on UN M.49 standard).
-
Example Sequences: Includes
ncbi-hev-examples
(10 GenBank XML sequences) andfasta-hev-examples
(10 FASTA sequences). -
Metadata Population:
- GenBank XML metadata is loaded using
genbankXmlPopulator
. - FASTA metadata is loaded using
textFilePopulator
.
- GenBank XML metadata is loaded using
- Genotyping: Example sequences are genotyped and added to the appropriate tip alignment in the alignment tree.
Explore the Command Line Interpreter tutorial to learn how to query the GLUE project and run analyses.
GLUE by Robert J. Gifford Lab.
For questions, issues, or feedback, please open an issue on the GitHub repository.
- Project Data Model
- Schema Extensions
- Modules
- Alignments
- Variations
- Scripting Layer
- Freemarker Templates
- Example GLUE Project
- Command Line Interpreter
- Build Your Own Project
- Querying the GLUE Database
- Working With Deep Sequencing Data
- Invoking GLUE as a Unix Command
- Known Issues and Fixes
- Overview
- Hepatitis Viruses
- Arboviruses
- Respiratory Viruses
- Animal Viruses
- Spillover Viruses
- Virus Diversity
- Retroviruses
- Paleovirology
- Transposons
- Host Genes