cbioportal-api-client - npm Package Compare versions

Comparing version 0.2.7 to 0.2.8

dist/utils/summarizeAlterations.js

@@ -138,5 +138,20 @@ 'use strict';
  *
- * Example response object:
+ * Basic Usage:
  *
  * ```javascript
+ * import CbioPortal from 'cbioportal-api-client';
+ * import { summarizeAlterations } from 'cbioportal-api-client/dist/utils';
+ *
+ * const cbioPortal = CbioPortal();
+ *
+ * cbioPortal.getProfileData({
+ *   case_set_id: 'gbm_tcga_cnaseq',
+ *   genetic_profile_id: ['gbm_tcga_mutations', 'gbm_tcga_gistic'],
+ *   gene_list: ['tp53', 'mdm2', 'mdm4']
+ * })
+ * .then(response => summarizeAlterations(response))
+ * .then(result => console.log(result));
+ *
+ * // console.log output
+ *
  * {
@@ -149,4 +164,15 @@ *   summary: {
  *         combined: 30
+ *       },
+ *       mdm2: {
+ *         mutated: 1,
+ *         cna: 9,
+ *         combined: 10
+ *       },
+ *       mdm4: {
+ *         mutated: 0,
+ *         cna: 10,
+ *         combined: 10
  *       }
- *     }
+ *     },
+ *     overall: 47
  *   }
@@ -153,0 +179,0 @@ * }

lib/utils/summarizeAlterations.js

@@ -96,5 +96,20 @@ /* eslint-disable no-param-reassign  */
  *
- * Example response object:
+ * Basic Usage:
  *
  * ```javascript
+ * import CbioPortal from 'cbioportal-api-client';
+ * import { summarizeAlterations } from 'cbioportal-api-client/dist/utils';
+ *
+ * const cbioPortal = CbioPortal();
+ *
+ * cbioPortal.getProfileData({
+ *   case_set_id: 'gbm_tcga_cnaseq',
+ *   genetic_profile_id: ['gbm_tcga_mutations', 'gbm_tcga_gistic'],
+ *   gene_list: ['tp53', 'mdm2', 'mdm4']
+ * })
+ * .then(response => summarizeAlterations(response))
+ * .then(result => console.log(result));
+ *
+ * // console.log output
+ *
  * {
@@ -107,4 +122,15 @@ *   summary: {
  *         combined: 30
+ *       },
+ *       mdm2: {
+ *         mutated: 1,
+ *         cna: 9,
+ *         combined: 10
+ *       },
+ *       mdm4: {
+ *         mutated: 0,
+ *         cna: 10,
+ *         combined: 10
  *       }
- *     }
+ *     },
+ *     overall: 47
  *   }
@@ -111,0 +137,0 @@ * }

package.json

 {
   "name": "cbioportal-api-client",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "cBio Portal API client with promises and response parsing",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -248,5 +248,20 @@ # cBio Portal API Client
 **Example**  
-Example response object:
+Basic Usage:
 
 ```javascript
+import CbioPortal from 'cbioportal-api-client';
+import { summarizeAlterations } from 'cbioportal-api-client/dist/utils';
+
+const cbioPortal = CbioPortal();
+
+cbioPortal.getProfileData({
+  case_set_id: 'gbm_tcga_cnaseq',
+  genetic_profile_id: ['gbm_tcga_mutations', 'gbm_tcga_gistic'],
+  gene_list: ['tp53', 'mdm2', 'mdm4']
+})
+.then(response => summarizeAlterations(response))
+.then(result => console.log(result));
+
+// console.log output
+
 {
@@ -259,4 +274,15 @@ summary: {
         combined: 30
+      },
+      mdm2: {
+        mutated: 1,
+        cna: 9,
+        combined: 10
+      },
+      mdm4: {
+        mutated: 0,
+        cna: 10,
+        combined: 10
       }
-    }
+    },
+    overall: 47
   }
@@ -263,0 +289,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

322171

increased by0.61%

Lines of code

1610

increased by3.34%

Number of lines in readme file

292

increased by9.77%

No dependency changes