Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • C CSpec Reasoner SVI
  • Project information
    • Project information
    • Activity
    • Members
  • Wiki
    • Wiki
  • Activity
Collapse sidebar
  • ClinGenClinGen
  • cspec
  • CSpec Reasoner SVI
  • Wiki
  • API

API · Changes

Page history
Update API authored Nov 03, 2022 by Neethu Shah's avatar Neethu Shah
Hide whitespace changes
Inline Side-by-side
API.md
View page @ a734c6a4
......@@ -14,7 +14,8 @@ Assertion API endpoint for computing variant pathogenicity given a set of eviden
>
> ```plaintext
> let payload = {
> cspecRuleSetUrl: 'https://cspec.genome.network/cspec/RuleSet/id/643243101',
> cspecRuleSetUrl: 'https://cspec.genome.network/cspec/RuleSet/id/643243101',
> // A specific ruleset defined by DICER1 and miRNA-Processing Gene Variant Curation Expert Panel - https://clinicalgenome.org/affiliation/50050
> evidence: {
> 'Pathogenic.Moderate': 2,
> 'Pathogenic.Strong': 1,
......@@ -23,118 +24,120 @@ Assertion API endpoint for computing variant pathogenicity given a set of eviden
> }
> }
> ```
>
> Example of how the route works:
```plaintext
const SimpleJsonReq = require( "@brl/brl-gb/client/simple/simpleJsonReq" ).SimpleJsonReq
let baseUrl = "https://cspec.genome.network/cspec/eng/svi"
let clientOpts = { timeout: 600000 }
let jsClient = undefined
let resp = undefined
jsClient = new SimpleJsonReq( baseUrl, clientOpts )
let reqConfig = {
serverCertCheck : false,
data: payload
}
resp = await jsClient.doGet('/assertion', reqConfig)
> ```plaintext
> const SimpleJsonReq = require( "@brl/brl-gb/client/simple/simpleJsonReq" ).SimpleJsonReq
> let baseUrl = "https://cspec.genome.network/cspec/eng/svi"
> let clientOpts = { timeout: 600000 }
> let jsClient = undefined
> let resp = undefined
> jsClient = new SimpleJsonReq( baseUrl, clientOpts )
> let reqConfig = {
> serverCertCheck : false,
> data: payload
> }
> resp = await jsClient.doGet('/assertion', reqConfig)
> console.log(global.brl.insp(global.brl.dot.pick('data', resp.data)))
{
comment: 'Two assertions: Pathogenic and Likely Pathogenic were made. In such case ' +
'the final call is the highest strength call, hence the allele is ' +
'Pathogenic',
finalCall: 'Pathogenic',
rules: [
{
conditions: [
{
applicableCriteriaCodes: [
'PVS1',
'PS2_Very Strong'
],
condition: '==1',
label: 'Rule1, Condition1',
partitionPath: 'Pathogenic.Very Strong'
},
{
applicableCriteriaCodes: [
'PS1',
'PS2',
'PS3',
'PS4',
'PP1_Strong'
],
condition: '>=1',
label: 'Rule1, Condition2',
partitionPath: 'Pathogenic.Strong'
}
],
inference: 'Pathogenic',
rule: 'Rule1'
},
{
conditions: [
{
applicableCriteriaCodes: [
'PVS1',
'PS2_Very Strong'
],
condition: '==1',
label: 'Rule2, Condition1',
partitionPath: 'Pathogenic.Very Strong'
},
{
applicableCriteriaCodes: [
'PS2_Moderate',
'PS3_Moderate',
'PS4_Moderate',
'PM1',
'PM4',
'PM5',
'PP1_Moderate'
],
condition: '>=2',
label: 'Rule2, Condition2',
partitionPath: 'Pathogenic.Moderate'
}
],
inference: 'Pathogenic',
rule: 'Rule2'
},
{
conditions: [
{
applicableCriteriaCodes: [
'PS1',
'PS2',
'PS3',
'PS4',
'PP1_Strong'
],
condition: '==1',
label: 'Rule20, Condition1',
partitionPath: 'Pathogenic.Strong'
},
{
applicableCriteriaCodes: [
'PS2_Moderate',
'PS3_Moderate',
'PS4_Moderate',
'PM1',
'PM4',
'PM5',
'PP1_Moderate'
],
condition: '==2',
label: 'Rule20, Condition2',
partitionPath: 'Pathogenic.Moderate'
}
],
inference: 'Likely Pathogenic',
rule: 'Rule20'
}
],
statusObj: {
name: 'assertion computed',
status: 'ok'
}
}
\ No newline at end of file
> {
> comment: 'Two assertions: Pathogenic and Likely Pathogenic were made. In such case ' +
> 'the final call is the highest strength call, hence the allele is ' +
> 'Pathogenic',
> finalCall: 'Pathogenic',
> rules: [
> {
> conditions: [
> {
> applicableCriteriaCodes: [
> 'PVS1',
> 'PS2_Very Strong'
> ],
> condition: '==1',
> label: 'Rule1, Condition1',
> partitionPath: 'Pathogenic.Very Strong'
> },
> {
> applicableCriteriaCodes: [
> 'PS1',
> 'PS2',
> 'PS3',
> 'PS4',
> 'PP1_Strong'
> ],
> condition: '>=1',
> label: 'Rule1, Condition2',
> partitionPath: 'Pathogenic.Strong'
> }
> ],
> inference: 'Pathogenic',
> rule: 'Rule1'
> },
> {
> conditions: [
> {
> applicableCriteriaCodes: [
> 'PVS1',
> 'PS2_Very Strong'
> ],
> condition: '==1',
> label: 'Rule2, Condition1',
> partitionPath: 'Pathogenic.Very Strong'
> },
> {
> applicableCriteriaCodes: [
> 'PS2_Moderate',
> 'PS3_Moderate',
> 'PS4_Moderate',
> 'PM1',
> 'PM4',
> 'PM5',
> 'PP1_Moderate'
> ],
> condition: '>=2',
> label: 'Rule2, Condition2',
> partitionPath: 'Pathogenic.Moderate'
> }
> ],
> inference: 'Pathogenic',
> rule: 'Rule2'
> },
> {
> conditions: [
> {
> applicableCriteriaCodes: [
> 'PS1',
> 'PS2',
> 'PS3',
> 'PS4',
> 'PP1_Strong'
> ],
> condition: '==1',
> label: 'Rule20, Condition1',
> partitionPath: 'Pathogenic.Strong'
> },
> {
> applicableCriteriaCodes: [
> 'PS2_Moderate',
> 'PS3_Moderate',
> 'PS4_Moderate',
> 'PM1',
> 'PM4',
> 'PM5',
> 'PP1_Moderate'
> ],
> condition: '==2',
> label: 'Rule20, Condition2',
> partitionPath: 'Pathogenic.Moderate'
> }
> ],
> inference: 'Likely Pathogenic',
> rule: 'Rule20'
> }
> ],
> statusObj: {
> name: 'assertion computed',
> status: 'ok'
> }
> }
> ```
\ No newline at end of file
Clone repository
  • API
  • Home