Skip to content

Latest commit

 

History

History
308 lines (226 loc) · 14.3 KB

BioentitysetApi.md

File metadata and controls

308 lines (226 loc) · 14.3 KB

BioentitysetApi

All URIs are relative to https://localhost/api

Method HTTP request Description
getEntitySetAssociations GET /bioentityset/associations/ Returns compact associations for a given input set
getEntitySetGraphResource GET /bioentityset/graph/ TODO Graph object spanning all entities
getEntitySetHomologsDeprecated GET /bioentityset/DEPRECATEDhomologs/ Returns homology associations for a given input set of genes
getEntitySetOverRepresentationAnalysis GET /bioentityset/ora/ TODO Over-representation analysis
getEntitySetOverRepresentationAnalysis_0 GET /bioentityset/ora/{object_category}/ TODO Over-representation analysis
getEntitySetSummary GET /bioentityset/descriptor/counts/ Summary statistics for objects associated

getEntitySetAssociations

List<AssociationResults> getEntitySetAssociations(objectSlim, objectCategory, subject, background)

Returns compact associations for a given input set

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.BioentitysetApi;


BioentitysetApi apiInstance = new BioentitysetApi();
String objectSlim = "objectSlim_example"; // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
String objectCategory = "objectCategory_example"; // String | E.g. phenotype, function
List<String> subject = Arrays.asList("subject_example"); // List<String> | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
List<String> background = Arrays.asList("background_example"); // List<String> | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
try {
    List<AssociationResults> result = apiInstance.getEntitySetAssociations(objectSlim, objectCategory, subject, background);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BioentitysetApi#getEntitySetAssociations");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
objectSlim String Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED [optional]
objectCategory String E.g. phenotype, function [optional]
subject List<String> Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387 [optional]
background List<String> Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests [optional]

Return type

List<AssociationResults>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getEntitySetGraphResource

getEntitySetGraphResource(objectSlim, objectCategory, subject, background)

TODO Graph object spanning all entities

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.BioentitysetApi;


BioentitysetApi apiInstance = new BioentitysetApi();
String objectSlim = "objectSlim_example"; // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
String objectCategory = "objectCategory_example"; // String | E.g. phenotype, function
List<String> subject = Arrays.asList("subject_example"); // List<String> | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
List<String> background = Arrays.asList("background_example"); // List<String> | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
try {
    apiInstance.getEntitySetGraphResource(objectSlim, objectCategory, subject, background);
} catch (ApiException e) {
    System.err.println("Exception when calling BioentitysetApi#getEntitySetGraphResource");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
objectSlim String Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED [optional]
objectCategory String E.g. phenotype, function [optional]
subject List<String> Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387 [optional]
background List<String> Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getEntitySetHomologsDeprecated

List<AssociationResults> getEntitySetHomologsDeprecated(objectSlim, objectCategory, subject, background)

Returns homology associations for a given input set of genes

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.BioentitysetApi;


BioentitysetApi apiInstance = new BioentitysetApi();
String objectSlim = "objectSlim_example"; // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
String objectCategory = "objectCategory_example"; // String | E.g. phenotype, function
List<String> subject = Arrays.asList("subject_example"); // List<String> | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
List<String> background = Arrays.asList("background_example"); // List<String> | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
try {
    List<AssociationResults> result = apiInstance.getEntitySetHomologsDeprecated(objectSlim, objectCategory, subject, background);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BioentitysetApi#getEntitySetHomologsDeprecated");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
objectSlim String Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED [optional]
objectCategory String E.g. phenotype, function [optional]
subject List<String> Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387 [optional]
background List<String> Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests [optional]

Return type

List<AssociationResults>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getEntitySetOverRepresentationAnalysis

getEntitySetOverRepresentationAnalysis(objectCategory, objectCategory2, objectSlim, subject, background)

TODO Over-representation analysis

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.BioentitysetApi;


BioentitysetApi apiInstance = new BioentitysetApi();
String objectCategory = "objectCategory_example"; // String | CATEGORY of entity at link OBJECT (target), e.g. phenotype, disease
String objectCategory2 = "objectCategory_example"; // String | E.g. phenotype, function
String objectSlim = "objectSlim_example"; // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
List<String> subject = Arrays.asList("subject_example"); // List<String> | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
List<String> background = Arrays.asList("background_example"); // List<String> | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
try {
    apiInstance.getEntitySetOverRepresentationAnalysis(objectCategory, objectCategory2, objectSlim, subject, background);
} catch (ApiException e) {
    System.err.println("Exception when calling BioentitysetApi#getEntitySetOverRepresentationAnalysis");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
objectCategory String CATEGORY of entity at link OBJECT (target), e.g. phenotype, disease
objectCategory2 String E.g. phenotype, function
objectSlim String Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED [optional]
subject List<String> Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387 [optional]
background List<String> Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getEntitySetOverRepresentationAnalysis_0

getEntitySetOverRepresentationAnalysis_0(objectCategory, objectCategory2, objectSlim, subject, background)

TODO Over-representation analysis

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.BioentitysetApi;


BioentitysetApi apiInstance = new BioentitysetApi();
String objectCategory = "objectCategory_example"; // String | CATEGORY of entity at link OBJECT (target), e.g. phenotype, disease
String objectCategory2 = "objectCategory_example"; // String | E.g. phenotype, function
String objectSlim = "objectSlim_example"; // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
List<String> subject = Arrays.asList("subject_example"); // List<String> | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
List<String> background = Arrays.asList("background_example"); // List<String> | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
try {
    apiInstance.getEntitySetOverRepresentationAnalysis_0(objectCategory, objectCategory2, objectSlim, subject, background);
} catch (ApiException e) {
    System.err.println("Exception when calling BioentitysetApi#getEntitySetOverRepresentationAnalysis_0");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
objectCategory String CATEGORY of entity at link OBJECT (target), e.g. phenotype, disease
objectCategory2 String E.g. phenotype, function
objectSlim String Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED [optional]
subject List<String> Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387 [optional]
background List<String> Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getEntitySetSummary

getEntitySetSummary(objectSlim, objectCategory, subject, background)

Summary statistics for objects associated

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.BioentitysetApi;


BioentitysetApi apiInstance = new BioentitysetApi();
String objectSlim = "objectSlim_example"; // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
String objectCategory = "objectCategory_example"; // String | E.g. phenotype, function
List<String> subject = Arrays.asList("subject_example"); // List<String> | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
List<String> background = Arrays.asList("background_example"); // List<String> | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
try {
    apiInstance.getEntitySetSummary(objectSlim, objectCategory, subject, background);
} catch (ApiException e) {
    System.err.println("Exception when calling BioentitysetApi#getEntitySetSummary");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
objectSlim String Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED [optional]
objectCategory String E.g. phenotype, function [optional]
subject List<String> Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387 [optional]
background List<String> Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json