BioLinkApi.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

[AssociationResults] getEntitySetAssociations(opts)

Returns compact associations for a given input set

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.BioentitysetApi();

var opts = { 
  'objectCategory': "objectCategory_example", // String | E.g. phenotype, function
  'subject': ["subject_example"], // [String] | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
  'background': ["background_example"], // [String] | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
  'objectSlim': "objectSlim_example" // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getEntitySetAssociations(opts, callback);

Parameters

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

Return type

[AssociationResults]

Authorization

No authorization required

HTTP request headers

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

getEntitySetGraphResource

getEntitySetGraphResource(opts)

TODO Graph object spanning all entities

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.BioentitysetApi();

var opts = { 
  'objectCategory': "objectCategory_example", // String | E.g. phenotype, function
  'subject': ["subject_example"], // [String] | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
  'background': ["background_example"], // [String] | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
  'objectSlim': "objectSlim_example" // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getEntitySetGraphResource(opts, callback);

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getEntitySetHomologsDeprecated

[AssociationResults] getEntitySetHomologsDeprecated(opts)

Returns homology associations for a given input set of genes

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.BioentitysetApi();

var opts = { 
  'objectCategory': "objectCategory_example", // String | E.g. phenotype, function
  'subject': ["subject_example"], // [String] | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
  'background': ["background_example"], // [String] | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
  'objectSlim': "objectSlim_example" // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getEntitySetHomologsDeprecated(opts, callback);

Parameters

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

Return type

[AssociationResults]

Authorization

No authorization required

HTTP request headers

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

getEntitySetOverRepresentationAnalysis

getEntitySetOverRepresentationAnalysis(objectCategory, objectCategory2, opts)

TODO Over-representation analysis

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.BioentitysetApi();

var objectCategory = "objectCategory_example"; // String | CATEGORY of entity at link OBJECT (target), e.g. phenotype, disease

var objectCategory2 = "objectCategory_example"; // String | E.g. phenotype, function

var opts = { 
  'subject': ["subject_example"], // [String] | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
  'background': ["background_example"], // [String] | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
  'objectSlim': "objectSlim_example" // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getEntitySetOverRepresentationAnalysis(objectCategory, objectCategory2, opts, callback);

Parameters

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

TODO Over-representation analysis

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.BioentitysetApi();

var objectCategory = "objectCategory_example"; // String | CATEGORY of entity at link OBJECT (target), e.g. phenotype, disease

var objectCategory2 = "objectCategory_example"; // String | E.g. phenotype, function

var opts = { 
  'subject': ["subject_example"], // [String] | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
  'background': ["background_example"], // [String] | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
  'objectSlim': "objectSlim_example" // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getEntitySetOverRepresentationAnalysis_0(objectCategory, objectCategory2, opts, callback);

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getEntitySetSummary

getEntitySetSummary(opts)

Summary statistics for objects associated

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.BioentitysetApi();

var opts = { 
  'objectCategory': "objectCategory_example", // String | E.g. phenotype, function
  'subject': ["subject_example"], // [String] | Entity ids to be examined, e.g. NCBIGene:9342, NCBIGene:7227, NCBIGene:8131, NCBIGene:157570, NCBIGene:51164, NCBIGene:6689, NCBIGene:6387
  'background': ["background_example"], // [String] | Entity ids in background set, e.g. NCBIGene:84570, NCBIGene:3630; used in over-representation tests
  'objectSlim': "objectSlim_example" // String | Slim or subset to which the descriptors are to be mapped, NOT IMPLEMENTED
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getEntitySetSummary(opts, callback);

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

Files

BioentitysetApi.md

Latest commit

History

BioentitysetApi.md

File metadata and controls

BioLinkApi.BioentitysetApi

getEntitySetAssociations

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitySetGraphResource

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitySetHomologsDeprecated

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitySetOverRepresentationAnalysis

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitySetOverRepresentationAnalysis_0

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitySetSummary

Example

Parameters

Return type

Authorization

HTTP request headers