Get details of an app

/apps/{app_id}

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call returns information about the specified app. The app should be one in a project that you can access; this could be an app that has been uploaded to CAVATICA by a project member, or a publicly available app that has been copied to the project.

https://cavatica-api.sbgenomics.com/v2/apps/{app_id}

šŸ‘

app_ids

Recall from the API Overview that the app_id has the form {project_owner}/{project}/{app_short_name}/{revision_number}.

If the revision_number field is omitted, the latest revision of the app is returned

You can get the app_id for an app by making the call to list all apps available to you

Request

Example request

GET /v2/apps/RFranklin/my-project/bamtools-merge-2-4-0 HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/bamtools-merge-2-4-0/0"

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.

Path parameters

NameDescription
app_idThe ID for the app you are querying. It can be obtained by making the call to list all apps available to you

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.

Response

See a list of CAVATICA-specific response codes that may be contained in the body of the response.

Example response body

{
  "href": "https://cavatica--api.sbgenomics.com/v2/apps/rfranklin/my-project/cummerbundqc/0",
  "id": "rfranklin/my-project/cummerbundqc/0",
  "project": "rfranklin/my-project",
  "name": "CummeRbundQC",
  "revision": 0,
  "raw": {
    "sbg:toolAuthor": "Cole Trapnell/University of Washington",
    "sbg:project": "rfranklin/my-project",
    "requirements": [],
    "id": "https://cavatica-api.sbgenomics.com/rfranklin/my-project/cummerbundqc/0/raw/",
    "sbg:toolkit": "CummeRbund",
    "sbg:revision": 0,
    "sbg:toolkitVersion": "2.8.2",
    "stdout": "",
    "outputs": [
      {
        "outputBinding": {
          "glob": "*.zip",
          "sbg:metadata": {},
          "sbg:inheritMetadataFrom": "#cuffdiff_zip"
        },
        "type": [
          "null",
          "File"
        ],
        "sbg:fileTypes": "ZIP",
        "description": "Downloadable zipped report.",
        "id": "#archive",
        "label": "Report archive"
      },
      {
        "outputBinding": {
          "glob": "*.b64html",
          "sbg:metadata": {},
          "sbg:inheritMetadataFrom": "#cuffdiff_zip"
        },
        "type": [
          "null",
          "File"
        ],
        "sbg:fileTypes": "B64HTML",
        "description": "Base64 encoded HTML report prepared for easy viewing.",
        "id": "#html",
        "label": "Report"
      }
    ],
    "inputs": [
      {
        "sbg:category": "Input files",
        "type": [
          "File"
        ],
        "sbg:fileTypes": "ZIP",
        "id": "#cuffdiff_zip",
        "description": "Zipped list of output tracking, tab delimited and INFO files.",
        "inputBinding": {
          "prefix": "--cuffzip",
          "separate": true,
          "sbg:cmdInclude": true
        },
        "label": "Archive of Cuffdiff output files"
      },
      {
        "sbg:category": "Basic Options",
        "type": [
          "null",
          "float"
        ],
        "id": "#dispersion_threshold",
        "description": "Changing this parameter sets threshold for the genes that are displayed on dispersion plot, namely it removes from the plot all genes that have dispersion lower than this value.",
        "sbg:toolDefaultValue": "0.01",
        "inputBinding": {
          "prefix": "--dispthreshold",
          "separate": true,
          "sbg:cmdInclude": true
        },
        "label": "Dispersion plot threshold"
      },
      {
        "sbg:category": "Basic Options",
        "type": [
          "null",
          "float"
        ],
        "id": "#density_threshold",
        "description": "Changing this parameter sets threshold for the genes that are displayed on both density plots. It removes from the plots all genes that have FPKM value lower than this value.",
        "sbg:toolDefaultValue": "0.0001",
        "inputBinding": {
          "prefix": "--densthreshold",
          "separate": true,
          "sbg:cmdInclude": true
        },
        "label": "Density plot threshold"
      },
      {
        "sbg:category": "Basic Options",
        "type": [
          "null",
          "boolean"
        ],
        "id": "#thresholds_off",
        "description": "Set this parameter in case you don't want to eliminate lower expressed genes on dispersion and density plots. Be aware that this would cause plots to be stretched in order to show these low values for dispersion and FPKM.",
        "sbg:toolDefaultValue": "False",
        "inputBinding": {
          "prefix": "--thresholdsoff",
          "separate": true,
          "sbg:cmdInclude": true
        },
        "label": "Turn off thresholds"
      }
    ],
    "hints": [
      {
        "class": "DockerRequirement",
        "dockerImageId": "0c4541b52eb7",
        "dockerPull": "images.sbgenomics.com/ana_d/cummerbund-qc:2.8.2--1.0"
      },
      {
        "class": "sbg:CPURequirement",
        "value": 8
      },
      {
        "class": "sbg:MemRequirement",
        "value": 6000
      }
    ],
    "sbg:modifiedOn": 1448366962,
    "sbg:latestRevision": 0,
    "sbg:id": "rfranklin/my-project/cummerbundqc/0",
    "sbg:job": {
      "inputs": {
        "cuffdiff_zip": {
          "class": "File",
          "size": 0,
          "path": "cuffdiff_zip.ext",
          "secondaryFiles": []
        },
        "density_threshold": 0,
        "dispersion_threshold": 0,
        "thresholds_off": true
      },
      "allocatedResources": {
        "cpu": 8,
        "mem": 6000
      }
    },
    "sbg:cmdPreview": "python /opt/cummerbund-qc.py --cuffzip cuffdiff_zip.ext --dispthreshold 0 --densthreshold 0 --thresholdsoff  cuffdiff_zip.ext",
    "description": "CummeRbundQC assesses the quality of a differential expression analysis performed with Cuffdiff. It accepts differential expression results in the form of a cuffdiff.zip folder as input and produces a report with charts that can be viewed on Seven Bridges platform or downloaded to your local drive. \n\nCummeRbundQC is built on top of CummeRbund v. 2.8.2. CummeRbundQC incorporates the \"Global Statistics and Quality Control\" graphs described in the CummeRbund manual. These visualizations provide an overview of the relationships among the replicates and help in detecting over-dispersion in samples.",
    "sbg:links": [
      {
        "id": "http://bioconductor.org/packages/release/bioc/html/cummeRbund.html",
        "label": "Homepage"
      },
      {
        "id": "http://bioconductor.org/packages/release/bioc/vignettes/cummeRbund/inst/doc/cummeRbund-manual.pdf",
        "label": "Manual"
      },
      {
        "id": "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC3334321/",
        "label": "Publication"
      }
    ],
    "temporaryFailCodes": [],
    "successCodes": [],
    "sbg:contributors": [
      "rfranklin"
    ],
    "label": "CummeRbundQC",
    "sbg:sbgMaintained": false,
    "baseCommand": [
      "python",
      "/opt/cummerbund-qc.py"
    ],
    "sbg:createdBy": "rfranklin",
    "class": "CommandLineTool",
    "sbg:modifiedBy": "rfranklin",
    "sbg:validationErrors": [],
    "sbg:revisionsInfo": [
      {
        "sbg:modifiedBy": "rfranklin",
        "sbg:modifiedOn": 1448366962,
        "sbg:revision": 0
      }
    ],
    "sbg:categories": [
      "Differential-Expression",
      "Plotting-and-Rendering"
    ],
    "arguments": [],
    "stdin": "",
    "sbg:license": "Artistic License 2.0",
    "sbg:createdOn": 1448366962
  }
}

Language