clinical-timelines - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

package.json

 {
   "name": "clinical-timelines",
   "description": "A general purpose graphical timeline library",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "author": "Rho, Inc.",
@@ -22,3 +22,3 @@ "license": "MIT",
   "scripts": {
-    "build": "npm run bundle && npm run format && npm run build-md && npm run test && npm run test-page",
+    "build": "npm audit fix && npm run bundle && npm run format && npm run build-md",
     "build-md": "node ./scripts/configuration-markdown.js",
@@ -33,3 +33,3 @@ "bundle": "rollup -c",
     "test-interactivity": "mocha --timeout 10000 --require babel-register --recursive ./test/interactivity/viewChange.js",
-    "test-page": "start chrome ./build/test-page/index.html && start firefox ./build/test-page/index.html && start iexplore file://%CD%/build/test-page/index.html",
+    "test-page": "start chrome ./test-page/index.html && start firefox ./test-page/index.html && start iexplore file://%CD%/test-page/index.html",
     "unit-test": "mocha --timeout 10000 --require babel-register --recursive ./test/call.js",
@@ -40,3 +40,3 @@ "watch": "rollup -c -w"
     "babel-plugin-external-helpers": "^6.22.0",
-    "babel-preset-env": "^1.6.0",
+    "babel-preset-env": "^1.7.0",
     "babel-register": "^6.26.0",
@@ -47,5 +47,4 @@ "expect": "^22.0.3",
     "prettier": "^1.7.4",
-    "rollup": "^0.50.0",
-    "rollup-plugin-babel": "^3.0.2",
-    "rollup-watch": "^4.3.1"
+    "rollup": "^0.66.6",
+    "rollup-plugin-babel": "^3.0.2"
   },
@@ -52,0 +51,0 @@ "repository": {

README.md

 # Clinical Timelines
-
 ![alt tag](https://user-images.githubusercontent.com/31038805/32514368-ccf98744-c3ca-11e7-890d-d10bba8350ff.gif)
 
 ## Overview
-
 Clinical Timelines is a JavaScript library that visualizes events over time via a faceted, interactive timeline chart.
@@ -18,10 +16,21 @@ While initially designed for use in clinical trial research, the library works with any longitudinal data of one record per event.
 ## Usage
+With a dataset that meets the [default variable requirements](https://github.com/RhoInc/clinical-timelines/wiki/Data-Guidelines), the renderer can be initialized with the following code:
 
+```javascript
+d3.csv(
+    'https://raw.githubusercontent.com/RhoInc/viz-library/master/data/safetyData/ADTIMELINES.csv',
+    function(data) {
+        clinicalTimelines('body', settings).init(data);
+    }
+);
+```
+
 Download the [latest release](https://github.com/RhoInc/clinical-timelines/releases/latest), which supports anonymous AMD, CommonJS, and vanilla environments.
-You can also load the library directly from [rawgit](https://rawgit.com/RhoInc/clinical-timelines/master/build/clinicalTimelines.js):
+You can also load the library directly from [jsDelivr](https://cdn.jsdelivr.net/npm/clinical-timelines/build/clinicalTimelines.js):
+Import into a webpage like so:
 
 ```html
 <script type = 'text/javascript' src = 'https://d3js.org/d3.v3.js'></script>
-<script type = 'text/javascript' src = 'https://rawgit.com/RhoInc/Webcharts/master/build/webcharts.js'></script>
-<script type = 'text/javascript' src = 'https://rawgit.com/RhoInc/clinical-timelines/master/build/clinicalTimelines.js'></script>
+<script type = 'text/javascript' src = 'https://cdn.jsdelivr.net/npm/webcharts/build/webcharts.js'></script>
+<script type = 'text/javascript' src = 'https://cdn.jsdelivr.net/npm/clinical-timelines/build/clinicalTimelines.js'></script>
 ```
@@ -36,3 +45,3 @@
 
-In Node:
+And in Node:
 
@@ -43,7 +52,7 @@ ```js
 ## Links
+More information is available in the project's [wiki](https://github.com/RhoInc/clinical-timelines/wiki):
 
-More information is available in the project's [wiki](https://github.com/RhoInc/clinical-timelines/wiki): 
-
+* [Interactive Example](https://rhoinc.github.io/clinical-timelines/test-page/)
 * [Data Guidelines](https://github.com/RhoInc/clinical-timelines/wiki/Data-Guidelines)
 * [API Reference](https://github.com/RhoInc/clinical-timelines/wiki/API)
 * [Release Notes](https://github.com/RhoInc/clinical-timelines/releases)

rollup.config.js

 import babel from 'rollup-plugin-babel';
 
-export default {
-    name: 'clinicalTimelines',
-    input: './src/index.js',
-    output:
-        {file: './build/clinicalTimelines.js',
-        format: 'umd'
+var pkg = require('./package.json');
+
+module.exports = {
+    input: pkg.module,
+    output: {
+        name: pkg.name
+            .split('-')
+            .map((str,i) =>
+                i === 0 ?
+                    str :
+                    (str.substring(0,1).toUpperCase() + str.substring(1))
+            )
+            .join(''),
+        file: pkg.main,
+        format: 'umd',
+        globals: {
+            d3: 'd3',
+            webcharts: 'webCharts'
+        },
     },
-    globals: {
-        d3: 'd3',
-        webcharts: 'webCharts'
-    },
     external: (function() {
-        var dependencies = require('./package.json').dependencies;
+        var dependencies = pkg.dependencies;
 
@@ -23,5 +32,3 @@ return Object.keys(dependencies);
             presets: [
-                ['env',
-                {'modules': false}
-                ]
+                [ 'env', {modules: false} ]
             ],
@@ -34,2 +41,2 @@ plugins: [
     ]
-}
+};

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

9

decreased by-10%

Number of lines in readme file

56

increased by19.15%

Worsened metrics

Total package byte prevSize

970076

decreased by-0.33%

Lines of code

10181

decreased by-0.98%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes