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
    Strategies for Sequencing Challenging Samples
    by seqadmin


    Despite advancements in sequencing platforms and related sample preparation technologies, certain sample types continue to present significant challenges that can compromise sequencing results. Pedro Echave, Senior Manager of the Global Business Segment at Revvity, explained that the success of a sequencing experiment ultimately depends on the amount and integrity of the nucleic acid template (RNA or DNA) obtained from a sample. “The better the quality of the nucleic acid isolated...
    03-22-2024, 06:39 AM
  • seqadmin
    Techniques and Challenges in Conservation Genomics
    by seqadmin



    The field of conservation genomics centers on applying genomics technologies in support of conservation efforts and the preservation of biodiversity. This article features interviews with two researchers who showcase their innovative work and highlight the current state and future of conservation genomics.

    Avian Conservation
    Matthew DeSaix, a recent doctoral graduate from Kristen Ruegg’s lab at The University of Colorado, shared that most of his research...
    03-08-2024, 10:41 AM

ad_right_rmr

Collapse

News

Collapse

Topics Statistics Last Post
Started by seqadmin, Yesterday, 06:37 PM
0 responses
11 views
0 likes
Last Post seqadmin  
Started by seqadmin, Yesterday, 06:07 PM
0 responses
10 views
0 likes
Last Post seqadmin  
Started by seqadmin, 03-22-2024, 10:03 AM
0 responses
51 views
0 likes
Last Post seqadmin  
Started by seqadmin, 03-21-2024, 07:32 AM
0 responses
68 views
0 likes
Last Post seqadmin  
Working...
X