Skip to content

giffordlabcvr/Lentivirus-GLUE

Repository files navigation

Lentivirus-GLUE

Welcome to the GitHub repository for Lentivirus-GLUE!

Lentiviruses (family Retroviridae, genus Lentivirus) are complex retroviruses that cause chronic, persistent infections in mammals, including humans. They are best known as the genus of retroviruses that includes human immunodeficiency virus type 1 (HIV-1).

Lentivirus-GLUE is a sequence-oriented resource for comparative genomic analysis of lentiviruses (family Retroviridae, genus Lentivirus), developed using the GLUE software framework.

GLUE is an open, integrated software toolkit that provides functionality for storage and interpretation of sequence data. It provides an extensible platform for implementing 'sequence-based resources' that represent the semantic links between sequences and other data items via a relational database. This minimises the requirement for labour-intensive pre-processing of data, and allows sequence-based analyses to be implemented in an efficient, standardised and reproducible way.

Please see the User Guide for more details.

Extension layers

This Lentivirus-GLUE project can be extended with additional layers, openly available via GitHub, including:

Table of Contents

Key Features

  • GLUE Framework Integration: Built on the GLUE software framework, Lentivirus-GLUE offers an extensible platform for efficient, standardized, and reproducible computational genomic analysis of Lentivirus virus.

  • Phylogenetic Structure: Sequence data in Lentivirus-GLUE is organized in a phylogenetically-structured manner, allowing users to explore evolutionary relationships easily.

  • Rich Annotations: Annotated reference sequences enable rigorous comparative genomic analysis related to conservation, adaptation, structural context, and genotype-to-phenotype associations.

  • Exploratory and operational: The GLUE framework allows sequence-based resources to be used for exploratory work in a research setting, as well as operational work in a public or animal health setting.

Installation

If you have not done so already, install the GLUE software framework by following the installation instructions on the GLUE web site:

Download the Lentivirus-GLUE repository, navigate into the top-level directory, and start the GLUE command line interpreter.

At the GLUE command prompt, run the 'buildLentivirusProject.glue' file as follows:

GLUE Version 1.1.107
Copyright (C) 2015-2020 The University of Glasgow
This program comes with ABSOLUTELY NO WARRANTY. This is free software, and you
are welcome to redistribute it under certain conditions. For details see
GNU Affero General Public License v3: http://www.gnu.org/licenses/

Mode path: /
GLUE> run file buildCoreProject.glue

This will build the base or 'core' project, which contains a minimal set of feature definitions, clade categories, reference sequences, and alignments.

Usage

GLUE contains an interactive command line environment focused on the development and use of GLUE projects by bioinformaticians. This provides a range of productivity-oriented features such as automatic command completion, command history and interactive paging through tabular data.

For detailed instructions on how to use Lentivirus-GLUE for your comparative genomic analysis, refer to the GLUE's reference documentation.

Contributing

We welcome contributions from the community! If you're interested in contributing to Lentivirus-GLUE, please review our Contribution Guidelines.

Contributor Covenant

License

The project is licensed under the GNU Affero General Public License v. 3.0

Contact

For questions, issues, or feedback, please open an issue on the GitHub repository.