Skip to content

Commit

Permalink
travis badge fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
cgroll committed Jun 1, 2015
1 parent 1f6995d commit e7e4ec2
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ notifications:
# uncomment the following lines to override the default test script
script:
- if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
- julia --check-bounds=yes -e 'Pkg.clone(pwd()); Pkg.build("JFinM_Charts"); Pkg.test("JFinM_Charts"; coverage=true)'
- julia --check-bounds=yes -e 'Pkg.clone(pwd()); Pkg.test("JFinM_Charts"; coverage=true)'
after_success:
- julia -e 'cd(Pkg.dir("JFinM_Charts")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
19 changes: 11 additions & 8 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A Julia interface to using the jfinm_d3_charts library.

- [![Build Status](https://travis-ci.org/JuliaFinMetriX/JFinM_Charts.svg?branch=master)](https://travis-ci.org/JuliaFinMetriX/JFinM_Charts.jl)
- [![Build Status](https://travis-ci.org/JuliaFinMetriX/JFinM_Charts.svg?branch=master)](https://travis-ci.org/JuliaFinMetriX/JFinM_Charts)
- [![Coverage Status](https://coveralls.io/repos/JuliaFinMetriX/JFinM_Charts/badge.svg)](https://coveralls.io/r/JuliaFinMetriX/JFinM_Charts)

# Documentation
Expand All @@ -12,18 +12,20 @@ A Julia interface to using the jfinm_d3_charts library.
# Description

There are two different graphics:
- graphics with embedded data: here data is included directly into the

- graphics with embedded data: data is included directly into the
javascript code, such that no external data file needs to be loaded.
An html graphics hence consists of a single html output file, and
viewing it does not require a local server.
- graphics loading data from an external file (.csv, .json, ...): for
reasons of performance, large data sets should be loaded from
external files. This, however, complicates things, as html files are
not allowed to load data from disk, so that any such html graphics
need to be viewed through some kind of server. This could either be
needs to be viewed through some kind of server. This could either be
a local http server, the server provided by github pages, or an
ipython notebook.


- renderHtml with localhost:
- for `D3VizExt` instances the only way of directly viewing a chart
outside of Jupyter / IJulia notebooks
Expand All @@ -34,9 +36,10 @@ There are two different graphics:
- vizHtml:
- create html output file and open in browser

#
# Internal setup

The most robust way to create a graphics is with the following steps:
The most robust and internally used way to create a graphics is with
the following steps:
- create data
- create customized chart instance
- create AbstractD3Viz instance:
Expand All @@ -45,12 +48,12 @@ The most robust way to create a graphics is with the following steps:
- render AbstractD3Viz instance:
- requires output path
- requires link to d3 library
- view rendered output file:
- view rendered output file (viz, embed):
- use local http server to view charts with external data files
- embed as iframe into notebook environments

In addition, however, there exist some shortcuts for frequently used
settings. They mainly can be splitted into disposable charts and
output files that need to be kept.
settings.

## Disposable charts

Expand Down
2 changes: 1 addition & 1 deletion src/d3viz.jl
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ function render_dviz(dviz::AbstractD3Viz, outPath::String,

close(fout)

return (outAbsPath, dviz)
return outAbsPath
end

## render functions: user interface to create html graphics
Expand Down

0 comments on commit e7e4ec2

Please sign in to comment.