npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

clinical-timeline

v0.0.30

Published

Clinical timeline in D3

Downloads

726

Readme

clinical-timeline

Build Status Code Climate Coverage Status Join the chat at https://gitter.im/cBioPortal/clinical-timeline API Doc

clinical-timeline builds upon the popular d3-timeline library, which displays a collection of timepoints in JSON format as a timeline. It focusses on visualization of clinical data on a timeline and extends the JSON format and the API with some new features and various plugins.

With the correct configuration one can instantiate a timeline as follows:

timeline-example

The index.html showcases clinical-timeline's features in an exhuastive way.

Building

Building the javascript files in clinical-timeline is handled by a Makefile. Makefiles are primarily used for building software on unix, but they are also great task runners. Executing the command make build in the root directory of clinical-timeline generates the distributable version of the timeline clinical-timeline.min.js in the dist/ directory post concatination and minification. Also the command make clean can be used to clean the dist/ directory. JSDoc syntax should be strictly followed for documentation as it is automatically build by doclets.

Examples

Note : Kindly browse over HTTP instead of HTTPS for the rawgit versions.

Documentation

Documentation for the library can be found here

Contributing

clinical-timeline is being actively developed and any kind of contribution to the repository is highly encouraged. For detailed instructions on contributing, one can use the Contributing Guide.

Checks before sending a PR:

  • Single commit and No merge commits. Make commits in logical/cohesive units.
  • Make sure your commit messages end with a Signed-off-by string (this line can be automatically added by git if you run the git-commit command with the -s option).
  • Please add a before/after screenshot or gif here with e.g. GifGrabber if there is a new visual feature.
  • Run all tests to assure nothing else was accidentally broken. This is done by running: npm test.
  • Make sure you have added the necessary tests and documentation for your changes.

clinical-timeline uses code-climate to maintain code quality and coveralls for code-coverage. Please ensure that the repo GPA and code-coverage doesn't falls if not increase post the new commit. Adding new unit tests is most welcomed.

License

LGPL

Testing

Setup:

  1. Run make clean build
  2. Copy the repo into frontend/node_modules
  3. Start up the frontend

Testing in timeline repo

  • Make sure timeline-example.json looks right
  • Make sure you can zoom, trim

Testing in actual frontend

Link: http://localhost:3000/patient?studyId=lgg_ucsf_2014&caseId=P17

  • Single click zoom
    • Should zoom in ~ 50%
    • Should not break if you click before the first tick mark
    • Should not break if you click after the last tick mark
    • Should not break if select a trim
  • Click and drag zoom
    • Should show ~ full region you selected
    • Should not break if you click before the first tick mark
    • Should not break if you click after the last tick mark
    • Should have reasonable units
    • Should not break if you select a region that includes a trim
    • Should zoom in more if you select a smaller region
  • General zooming
    • Points and ticks are in the right place (verify by looking at start date)
    • Should not break if you zoom in, zoom out, zoom in
  • Zooming + trimming
    • http://localhost:3000/patient?studyId=lgg_ucsf_2014&caseId=P04
    • If no trimming occurs when zoomed out, no trimming should occur if you zoom in