Global

Members

debug

Set to true to debug http requests
Source:

Methods

arrayify(data) → {Array}

Check if some data is an array and return either itself if it is an array or an array with it as the first member if it is not. Used for the cases where the API returns either an array or a singleton.
Parameters:
Name Type Description
data Object
Author:
License:
Source:
Returns:
Type
Array

encodeParams(params) → {String}

Turns an object containing key/value pairs into URI encoded 'key1=value1&key2=value2...' parameters for an http request.
Parameters:
Name Type Description
params Object
Author:
License:
Source:
Returns:
Type
String

nets()

Perform HTTP(S) request using nets. Optional debugging of URL and results.
Source:

Type Definitions

AssociationsResponse

Contains list of disease target associations for a target fetched with DiseaseSearch#associationsByTarget or disease fetched with DiseaseSearch#associationsByDisease
Type:
  • Array.<Object>
Properties:
Name Type Description
about string link to source files describing the disease-target associations
dataset string link to the void dataset describing the links between the diseases and other datasets
description Array.<string> description
disease Array.<DiseaseResponse> disease
gene Array.<object> containing URI for the gene, link to the gene it encodes, encodesLabel and encodesProvenance link to where the label came from
pmid Array.<string> pubmed ID
primarySource Array.<string> primarySource
type Array.<Object> containing URI and label
Source:

DiseaseResponse

Contains list of diseases contained within a AssociationsResponse
Type:
  • Array.<Object>
Properties:
Name Type Description
URI string link to the disease
dataset string source of the data
diseaseClasses Array.<Object> containing URI, source dataset and name
Source:

DiseasesByTargetResponse

Contains list of diseases for a single target fetched with DiseaseSearch#diseasesByTarget
Type:
  • Array.<Object>
Properties:
Name Type Description
URI string URI
name string name
gene Array.<object> containing URI for the gene and an array of encoded genes with link to the gene it encodes, label and provenance link to where the label came from
Source:

FetchCompoundBatchResponse

Contains data for compounds fetched with CompoundSearch#fetchCompoundBatch
Type:
  • Array.<Object>
Properties:
Name Type Description
cwURI string Concept Wiki URI which represents the compound
prefLabel string The preferred label for the compound
URI string The URI for the compound
description string A description of the compound
biotransformationItem string The biotransformation item for the compound
toxicity string The toxicity of the compound
proteinBinding string The protein binding for the compound
csURI string ChemSpider URI
hba string hba
hbd string hbd
inchi string inchi
logp string logp
psa string psa
ro5Violations string ro5Violations
smiles string smiles
chemblURI string chemblURI
fullMWT string fullMWT
molform string molform
mwFreebase string mwFreebase
rtb string rtb
inchiKey string inchiKey
drugbankURI string drugbankURI
drugbankProvenance string drugbankProvenance
chemspiderProvenance string chemspiderProvenance
chemblProvenance string chemblProvenance
Source:

FetchCompoundLensResponse

Contains various types of data about the compounds matching a source compound when a lens is applied using CompoundSearch#fetchCompound Note that the items in each list cannot be linked together but you can use the MapSearch#mapURL call to discover which items are about the same compound.
Type:
  • Array.<Object>
Properties:
Name Type Description
lensChemspider Array List of compounds from chemspider
lensDrugbank Array list of drugbank info items relating to the chemspider compounds
lensCW Array list of conceptwiki info about the compounds
lensChembl Array list of chembl info items about the compounds
Source:

FetchCompoundPharmacologyResponse

An array of pharmacology records for a compound returned from CompoundSearch#compoundPharmacology
Type:
  • Array.<Object>
Properties:
Name Type Description
compoundInchikey string compound_inchikey
compoundDrugType string compound_drug_type
compoundGenericName string compound_generic_name
targets Array targets
compoundInchikeySrc string cs_src
compoundDrugTypeSrc string drugbank_src
compoundGenericNameSrc string drugbank_src
targetTitleSrc string chembl_src
chemblActivityUri string chembl_activity_uri
chemblCompoundUri string chembl_compound_uri
compoundFullMwt string compound_full_mwt
cwCompoundUri string cw_compound_uri
compoundPrefLabel string compound_pref_label
csCompoundUri string cs_compound_uri
csid string csid
compoundInchi string compound_inchi
compoundSmiles string compound_smiles
chemblAssayUri string chembl_assay_uri
targetOrganisms Array target_organisms
assayOrganism string assay_organism
assayDescription string assay_description
activityRelation string activity_relation
activityStandardUnits string activity_standard_units
activityStandardValue string activity_standard_value
activityActivityType string activity_activity_type
activityValue string activity_activity_value
compoundFullMwtSrc string chembl_src
compoundPrefLabel_src string cw_src
compoundInchiSrc string cs_src
compoundSmilesSrc string cs_src
targetOrganismSrc string chembl_src
assayOrganismSrc string chembl_src
assayDescriptionSrc string chembl_src
activityRelationSrc string chembl_src
activityStandardUnitsSrc string chembl_src
activityStandardValueSrc string chembl_src
activityActivityTypeSrc string chembl_src
activityPubmedId string activity_pubmed_id
assayDescriptionItem string assay_description_item
assayOrganismItem string assay_organism_item
activityActivityTypeItem string activity_activity_type_item
activityRelationItem string activity_relation_item
activityStandardValueItem string activity_standard_value_item
activityStandardUnitsItem string activity_standard_units_item
compoundFullMwtItem string compound_full_mwt_item
compoundSmilesItem string compound_smiles_item
compoundInchiItem string compound_inchi_item
compoundInchikeyItem string compound_inchikey_item
compoundPrefLabelItem string compound_pref_label_item
pChembl string pChembl
chemblProvenance string chemblProvenance
Source:

FetchCompoundResponse

Contains data for a compound fetched with CompoundSearch#fetchCompound
Type:
  • Object
Properties:
Name Type Description
cwURI string Concept Wiki URI which represents the compound
prefLabel string The preferred label for the compound
URI string The URI for the compound
description string A description of the compound
biotransformationItem string The biotransformation item for the compound
toxicity string The toxicity of the compound
proteinBinding string The protein binding for the compound
csURI string ChemSpider URI
hba string hba
hbd string hbd
inchi string inchi
logp string logp
psa string psa
ro5Violations string ro5Violations
smiles string smiles
chemblURI string chemblURI
fullMWT string fullMWT
molform string molform
mwFreebase string mwFreebase
rtb string rtb
inchiKey string inchiKey
drugbankURI string drugbankURI
drugbankProvenance string drugbankProvenance
chemspiderProvenance string chemspiderProvenance
chemblProvenance string chemblProvenance
Source:

FetchDiseaseResponse

Contains information about a single disease fetched with DiseaseSearch#fetchDisease
Type:
  • Object
Properties:
Name Type Description
URI string URI
name string name
diseaseClass Array diseaseClass
Source:

FetchTargetBatchResponse

Contains data for targets fetched with TargetSearch#fetchTargetBatch
Type:
  • Array.<Object>
Properties:
Name Type Description
cellularLocation string cellularLocation
molecularWeight string molecularWeight
numberOfResidues string numberOfResidues
theoreticalPi string theoreticalPi
drugbankURI string drugbankURI
keywords- Array keywords
functionAnnotation string functionAnnotation
alternativeName string alternativeName
existence string existence
organism string organism
sequence string sequence
classifiedWith Array classifiedWith
seeAlso Array seeAlso
prefLabel string prefLabel
chemblItems string chemblItems
cwURI string cwURI
URI string URI
chemblProvenance string chemblProvenance
drugbankProvenance string drugbankProvenance
uniprotProvenance string uniprotProvenance
conceptwikiProvenance string conceptwikiProvenance
Source:

FetchTargetResponse

Contains data for a target fetched with TargetSearch#fetchTarget
Type:
  • Object
Properties:
Name Type Description
cellularLocation string cellularLocation
molecularWeight string molecularWeight
numberOfResidues string numberOfResidues
theoreticalPi string theoreticalPi
drugbankURI string drugbankURI
keywords- Array keywords
functionAnnotation string functionAnnotation
alternativeName string alternativeName
existence string existence
organism string organism
sequence string sequence
classifiedWith Array classifiedWith
seeAlso Array seeAlso
prefLabel string prefLabel
chemblItems string chemblItems
cwURI string cwURI
URI string URI
chemblProvenance string chemblProvenance
drugbankProvenance string drugbankProvenance
uniprotProvenance string uniprotProvenance
conceptwikiProvenance string conceptwikiProvenance
Source:

requestCallback(success, status, response)

General callback for any request
Parameters:
Name Type Description
success Boolean True or False
status Number HTTP status code
response string Response message
Source:

TargetsByDiseaseResponse

Contains list of targets for a particular disease fetched with DiseaseSearch#targetsByDisease
Type:
  • Array.<Object>
Properties:
Name Type Description
URI string URI
dataset string dataset
Source: