Giter Club home page Giter Club logo

viz-library's People

Contributors

agstn avatar jsdelivrbot avatar jwildfire avatar muang0 avatar pburnsdata avatar rtbailey avatar samussiah avatar traviscibot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

viz-library's Issues

update data source on test-page examples

Need to make sure all test-pages pull data from data-library instead of viz-library\data, and that they use jsdelivr instead of rawgit

  • - webcharts
  • - safety-outlier-explorer
  • - ae-timelines
  • - aeexplorer
  • - clinical-timelines
  • - crf-heat-map
  • - dashboard-charts
  • - dashboard-framework
  • - paneled-outlier-explorer
  • - participant-visit-listing
  • - PopulationExplorer
  • - Query-overview
  • - safety-explorer-suite
  • - safety-histogram
  • - safety-results-over-time
  • - safety-shift-plot
  • - spike-histogram
  • - web-codebook

Allow examples with multiple charts/pages

Leaning towards allowing an arbitrary number of subfolders for any given example each of which is 'built' using the same process for the root project folder. The person who creates the example will be responsible for providing a way to navigate between the folders ... at least at first.

Use https in examples

Use https (instead of http) in all <script> calls under bin/gists/oden/ (like here)

Otherwise you get this error when viewing the example on github.io:

screen shot 2017-05-22 at 1 50 07 pm

Refactor Example Appearance/workflow

Problems

  • The example pages look ๐Ÿคข
  • Tracking metadata in a custom readme header is ๐Ÿ˜–

Proposed refactor

Refactor the example build and appearance to:

  • Get rid of the ugly header and just use a simple 2-level nav. Top nav is the same as the front page. Second nav gives basic info about the example with links to more detail.
  • Get rid of iframes and use a simple templated header on example pages instead.
  • Track meta data using example-level package.json instead of inventing our own custom metadata tracking format.

Updated Example Requirements

Once the core content for an example has been created (index.html, image files, readme.md, etc), the user must create an independent package.json for the example. The information from package.json will be used to format the header for the example when the viz-library website is created (via npm run build).

The parameters for the package.json are:

  • homepage required - The path to your example that they user should see when the page is loaded. This can be an image or an html file.
  • main required: The path the script that created your working example. Most typically an R or js file in our case.
  • name required - A short name for your example
  • version required - use semantic versioning for each example.
  • label - A nicely formatted version of name above (e.g. "simple-barchart" -> "Simple Barchart"). Note that this is a custom field that isn't in the npm package.json spec
  • license
  • author
  • description
  • keywords - include the programming language(s) (e.g. "R" or "js")
  • dependencies - Links to any npm packages used to create the example
  • rDependencies - References to any r packages used to create the example. Note that this is a custom field that isn't in the npm package.json spec, but follows the typical name:version format for npm dependencies.
  • dataDependencies - Array to data files used to create the example. Note that this is a custom field that isn't in the npm package.json spec, but uses a simple array of data paths instead of the typical name:version format for npm dependencies.

Example package.json

A typical pacakge.json for an example might look like this:

{
  "homepage":"./example.html",
  "main": "simpleBarChart.js",
  "name": "simple-barchart-webcharts",
  "version": "1.0.0",
  "description": "This is a simple bar chart showing counts of medals won by country at the 2012 summer Olympics. Made with Webcharts.",
  "author": "Rho, Inc.",
  "license": "MIT",
  "keywords":["javascript","interactive","bar chart"],
  "dependencies": {
    "d3": "~3",
    "webcharts":"~1"
  },
  "dataDependecies":["./OlympicMedals2012.csv"]
}

Nav not working on Safety Explorer examples

The nav bar on the Safety Explorer Chart examples in the Viz Library (Default and Query Data versions) don't appear to be working. Chrome renders nothing when I click on one of the other charts. Firefox spits out: "301 Moved Permanently"

Migrate examples from graphics.rhoworld.com to test pages

  • Studies/LEAP/AES -> test page
  • Studies/LEAP/Figure3 -> new repo
  • Studies/PROSE/Subgroups -> new repo
  • Tools/Labnormal -> new repo?
  • Tools/OpenFDA -> archived - tool is broken - note added to readme
  • Tools/AEExplorer/exampleX -> Test page
  • Tools/Beeswarm -> new repo
  • Tools/AxisMacro -> test page
  • Tools/Sankeybarchart -> test page

The list of the prototypes that are not displaying

The following prototypes are not displaying and need to be fixed:

  • Movies With Friends
  • Safety Outlier Explorer - Example
  • D3 Formatting Example
  • Baseball Statistics Histogram III - Webcharts-templates
  • Baseball Statistics Histogram II - Webcharts-templates
  • Baseball Statistics Histogram - Webcharts-templates

Set up redirects to new test pages for existing example URLs

Simple js redirects seems to work fine. Just update index.html as shown below and then delete other files:

<html lang="en"><head>
  <title></title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
  This page has moved. You will be redirected to the <a href="https://rhoinc.github.io/r-library/examples/0006-precip-levelplot-lattice/">new location</a> momentarily ...
</body>
  <script>
    window.location.replace("https://rhoinc.github.io/r-library/examples/0006-precip-levelplot-lattice/");
  </script>
</html>

Migration checklist

  • example 1 - R
  • example 2 - R
  • example 3 - R
  • example 4 - R
  • example 5 - R
  • example 6 - R
  • example 7 - webcharts
  • example 8 - safetyExplorerSuite
  • example 9 - webcodebook
  • example 10 - spike histogram
  • example 11 - safetyExplorerSuite
  • example 12 - web-codebook
  • example 13 - queryoverview
  • example 15 - safetyexplorersuite
  • example 16 - safetyexplorersuite
  • example 17 - population explorer
  • example 18 - scatterplot matrix
  • example 19 - paneled outlier explorer
  • example 20 - webcharts
  • example 21 - webcharts
  • example 22 - clinicaltimelines

Broken Links to Download Data

The following charts have links to download data that either point you back to the Viz Library homepage or show an error "file not found" message:

Ordered Precipitation Heatmap
Spike Histogram Demo
Web Codebook Demo
Interactive Scatter Plot Lattice with Viral Signs Data
Unemployment Trends with a Multivariate Time Series
Simple Interactive Bar Chart (results data = null)
Safety Explorer Suite - Single Page
Web Codebook Explorer
Safety Explorer - Default Configuration

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.