Skip to content

OSS-Lab/MetQy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MetQy - metabolic query

MetQy is a R package to ease interfacing with the Kyoto Encyclopedia of Genes and Genomes (KEGG) database to query metabolic functions of genes and genomes. As discussed in detail in the associated paper (see above), MetQy can be used to convert key parts of the data contained in the KEGG database into R data structures, and perform analyses on this data. Below we provide a simple example of how MetQy can be used to analyze a set of given genomes for the presence of a set of given metabolic capabilities (i.e. modules).

Using MetQy

CITE US

Please cite:

    Andrea Martinez-Vernon, Fred Farrell, Orkun Soyer. MetQy - an R package to query metabolic functions of genes and genomes. 
        Bioinformatics, Volume 34, Issue 23, 01 December 2018, Pages 4134–4137, https://doi.org/10.1093/bioinformatics/bty447   

https://doi.org/10.1093/bioinformatics/bty447

Commercial use

MetQy is a free software for academic purposes. If interested in commercial use, please read the LICENCE and contact Warwick Ventures

Installation

There are three ways of installing the package:

  1. Run the following command within the R environment. Requires package devtools

    # > install.packages("devtools") # Uncomment if not previously installed 
    
    # Install MetQy - required dependent packages are installed automatically
    > devtools::install_github('OSS-Lab/MetQy',subdir = 'MetQy_1.1.0',dependencies = TRUE) # 
    
  2. Download the "MetQy_1.1.0" folder and create a 'MetQy_1.1.0.tar.gz' file using the 'tar' command. Then run the following commands within the R environment:

    # Manually install dependent packages - remove any that is already installed. Installing will replace local library.
    > install.packages(c("dplyr","ggplot2","gsubfn","reshape2","xtable"))
    
    # Install MetQy
    > install.packages('<path_to_directory>/MetQy_1.1.0.tar.gz',repos=NULL)
    > library(MetQy)
    
  3. Download 'MetQy_1.1.0.tgz' and run the following commands within the R environment:

    ## Note that this option might only be compatible with OS X. 
    
    # Manually install dependent packages - remove any that is already installed. Installing will replace local library.
    > install.packages(c("dplyr","ggplot2","gsubfn","reshape2","xtable"))
    
    # Install MetQy
    > install.packages('<path_to_directory>/MetQy_1.1.0.tgz',repos=NULL)  # QUICKER
    > library(MetQy)
    

More Info

Detailed information on MetQy functions, along with usage examples and a sample analyses can be found on associated Wiki page.

Wiki menu