Giter VIP home page Giter VIP logo

visualization-tools's Introduction

visualization-tools Build Status

This Repo is around to keep track of Visualization Tool Annotations that are compatible with the Refinery Platform

Before Coding:

Adding/Editing Visualization Tool Annotations:

  • Make a PR here with your .json file added to the tool-annotations directory
  • The CI pipeline will attempt to load your tool into a Refinery instance
  • Changes can be merged if your build passes!

Related Projects:

Containerized Visualizations:

Demo, Testing, and Stub Containers:

visualization-tools's People

Contributors

gmnelson avatar ilan-gold avatar mccalluc avatar scottx611x avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

doanle0906

visualization-tools's Issues

VisualizationTool Integration Tests

Currently we have a few Selenium-based Integration tests in Refinery for Vis-Tool Launches (IGV, HiGlass), but these are slowing down our test suite over there/are quite flaky to run due to Selenium waiting and would be more appropriate in this repo.

With that being said, the UI tests are nice but maybe a bit overkill. It would be great if we could just specify a sample input.json along with a Vis-Tool and try to run a container with it through django-docker-engine.

Since we already have access to the Refinery code in our CI here, we could have a new repo structure here like:

├── LICENSE
├── README.md
├── ci_tests.py
└── tool-annotations
    ├── heatmap-scatterplot
        ├── heatmap-scatterplot.json
        ├── input.json
    ├── higlass
        ├── higlass.json
        ├── input.json
    ├── igv
        ├── igv.json
        ├── input.json
   ├── refinery-developer-tool
        ├── refinery-developer-tool.json
        ├── input.json

Where we would provide input.json(s) along with our Tool Annotations and attempt to:

  • Create ToolDefinitions from these ToolAnnotations (we're doing this currently)
  • Launch a container through django-docker-engine utilizing the provided input.json. This would need to satisfy the code in VisualizationTool.launch() which would mean that we'd need to create valid Nodes & FileStoreItems which could start to get tricky.
  • Assert that we can get a 200 from each of the launched containers

EDIT: Thinking about this again, we could just have users provide the FILE_RELATIONSHIPS structure with urls pointing to reasonable test files that they could check into this repo as well (Could specify the raw.github.... versions). Then when we launch the Tool, we wouldn't have to worry about creating Refinery-specific objects.

Remove `container_input_path` from Tool Annotations

We can most likely remove the container_input_path keys from the annotations in this repo

The Refinery JSON Schema doesn't require it now, where it did at some point in the past.

We should be diligent to make sure that the underlying Tools aren't using the information anymore before we go ahead and remove.

Checkout of master branch during CI/CD && expand build matrix?

Right now we are validating new ToolAnnotations against the latest Refinery application code, which is great, but we won't be able to ensure that these work with the latest release of Refinery.

Running the integration tests against develop & master would probably be a good idea

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.