Seqanswers Leaderboard Ad

Collapse

Announcement

Collapse
No announcement yet.
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

  • GeneTrail 2

    I've really started liking this tool called GeneTrail 2. There is a REST API for it and I'd like to take full advantage of it in R. There is already a client written in Python that I haven't tried using. So much of my pipelines are in R though I'd hate to have to switch.

    Using R6Class I've been able to get the bare bones of the client working:

    Code:
    ##
    # Gene Trail 2 Client class
    #
    GeneTrail2Client <- R6Class(
        'GeneTrail2Client',
        public = list(
            initialize = function(
                username, password, sessionId )
            {
                if ( !missing( username ) && !missing( password ) )
                    self$login( username, password )
                if ( !missing( sessionId ) )
                    private$sessionId <- sessionId
                else private$sessionId <-self$getSessionId()
                cat( private$sessionId, '\n' )
            },
            getAPIdoc = function()
            {
                return( self$doGet( '/api-docs' ) )
            },
            login = function( username, password )
            {
                return( self$doPost( '/user/login?username=%s&password=%s', username, password ) )
            },
            getSessionId = function()
            {
                if ( is.na( private$sessionId ) )
                    private$sessionId <- self$doGet( '/session' )[['session']]
                return( private$sessionId )
            },
            uploadGenes = function( genesFile, displayName )
            {
                cat( paste0( 'https://genetrail2.bioinf.uni-sb.de/results.html?session=', private$sessionId, '&show_all_results=true\n' ) )
                return( fromJSON( RCurl::postForm(
                    sprintf( paste0( private$GT_URL, '/upload?session=%s' ),
                        private$sessionId ),
                    file = fileUpload( genesFile ) ) ) )#, displayName = displayName ) ) )
            },
            getJobAlgorithms = function()
            {
                return( self$doGet( '/job/algorithms' ) )
            },
            getJobAlgorithmParameters = function( algorithm )
            {
                return( self$doGet( '/job/parameters/%s', algorithm ) )
            },
            startJob = function( contact )
            {
                if ( missing( contact ) )
                    return( self$doGet( '/job/start?session=%s', private$sessionId ) )
                else
                    return( self$doGet( '/job/start?session=%s&contact=%s', private$sessionId, contact ) )
            },
            setupJob = function( algorithm, ... )
            {
                return( self$doPostForm(
                    sprintf( paste0( private$GT_URL, '/job/setup/%s?session=%s' ),
                        algorithm, private$sessionId ), ... ) )
            },
            stopJob = function()
            {
                return( self$doGet( '/job/stop?session=%s', private$sessionId ) )
            },
            runGSEA = function( genes, jobName )
            {
                job <- self$uploadGenes( genes, jobName )
                return( job )
            },
            getGT_URL = function()
            {
                return( private$GT_URL )
            },
            doGet = function( endpoint, ... )
            {
                return( fromJSON( RCurl::httpGET(
                    sprintf( paste0( private$GT_URL, endpoint ), ... ),
                    httpheader = list(
                        Accept         = 'application/json',
                        `Content-type` = 'application/x-www-form-urlencoded' )
                    ) ) )
            },
            doPost = function( endpoint, ... )
            {
                return( fromJSON( RCurl::httpPOST(
                    sprintf( paste0( private$GT_URL, endpoint ), ... ),
                    httpheader = list(
                        Accept         = 'application/json',
                        `Content-type` = 'application/x-www-form-urlencoded' )
                    ) ) )
            },
            doPostForm = function( url, ... )
            {
                return( fromJSON( RCurl::postForm( url, style = 'POST', ... ) ) )
            },
            doPut = function( endpoint, content, ... )
            {
                return( fromJSON( RCurl::httpPUT(
                    sprintf( paste0( private$GT_URL, endpoint ), ... ),
                    content,
                    httpheader = list(
                        Accept         = 'application/json',
                        `Content-type` = 'application/x-www-form-urlencoded' )
                    ) ) )
            },
            api = list(
                API_DOC = '/api-docs',
                USER    = list(
                    login = '/user/login?username=%s&password=%s'
                ),
                SESSION = list(
                    get    = '/session',
                    PUTseal   = '/session/%s/seal',
                    DELETE = '/session/%s'
                ),
                UPLOAD = list(
                    uploadGenes = '/upload?session=%s&displayName=%s'
                ),
                JOB     = list(
                    getAlgorithms = '/job/algorithms',
                    getParameters = '/job/parameters/%s',
                    startJob      = '/job/start?session=%s',
                    setupJob      = '/job/setup/%s?session=%s',
                    stopJob       = '/job/stop?session=%s'
                ),
                RESOURCE = list(
                )
            )
        ),
        private = list(
            GT_URL = 'https://genetrail2.bioinf.uni-sb.de/api',
            sessionId = NA
        )
    )
    My hope is someone will eventually just create the R package. (I wish I had the ability to do so myself.) Until that happens though, is there anyone that could assist me in figuring out how to, through the API, retrieve recommended parameters. This is a feature you get through the web portal where the web applications reports: "Based on your uploaded data we recommend the following parameters." but this is something I'd like to simply be able to kick off with default parameters.

    If it helps, I've attached a POSTMAN json file with a bunch of calls to the API which is listed here with Swagger UI. (Sadly, the Swagger UI is BROKEN... the url in the api calls
    'https://genetrail2.bioinf-uni-sb.de/api/api-docs/' when it is supposed to be
    'https://genetrail2.bioinf.uni-sb.de/api/api-docs/'. smh)

    Thanks,
    Alex
    Attached Files
    Last edited by axa9070; 05-25-2016, 02:12 PM. Reason: Hard to read URLS

Latest Articles

Collapse

  • seqadmin
    Essential Discoveries and Tools in Epitranscriptomics
    by seqadmin




    The field of epigenetics has traditionally concentrated more on DNA and how changes like methylation and phosphorylation of histones impact gene expression and regulation. However, our increased understanding of RNA modifications and their importance in cellular processes has led to a rise in epitranscriptomics research. “Epitranscriptomics brings together the concepts of epigenetics and gene expression,” explained Adrien Leger, PhD, Principal Research Scientist...
    Yesterday, 07:01 AM
  • seqadmin
    Current Approaches to Protein Sequencing
    by seqadmin


    Proteins are often described as the workhorses of the cell, and identifying their sequences is key to understanding their role in biological processes and disease. Currently, the most common technique used to determine protein sequences is mass spectrometry. While still a valuable tool, mass spectrometry faces several limitations and requires a highly experienced scientist familiar with the equipment to operate it. Additionally, other proteomic methods, like affinity assays, are constrained...
    04-04-2024, 04:25 PM

ad_right_rmr

Collapse

News

Collapse

Topics Statistics Last Post
Started by seqadmin, 04-11-2024, 12:08 PM
0 responses
57 views
0 likes
Last Post seqadmin  
Started by seqadmin, 04-10-2024, 10:19 PM
0 responses
53 views
0 likes
Last Post seqadmin  
Started by seqadmin, 04-10-2024, 09:21 AM
0 responses
45 views
0 likes
Last Post seqadmin  
Started by seqadmin, 04-04-2024, 09:00 AM
0 responses
55 views
0 likes
Last Post seqadmin  
Working...
X