diff --git a/chart-unit.cabal b/chart-unit.cabal --- a/chart-unit.cabal +++ b/chart-unit.cabal @@ -1,11 +1,22 @@ name: chart-unit version: - 0.3.2 + 0.4.0 synopsis: - A set of native haskell charts. + Native haskell charts. description: - See https://tonyday567.github.io/chart-unit/index.html for some description. + See for chart bling and usage. + . + . + <> + . + These charts are designed to be scale independent and amenable to combinatory busywork (hence the unit suffix). + . + . +extra-source-files: + readme.md + index.html + stack.yaml category: charts homepage: @@ -45,7 +56,7 @@ lens, linear, numhask >= 0.0.4 && < 1, - numhask-range >= 0.0.2 && < 1, + numhask-range >= 0.0.3 && < 1, text default-language: Haskell2010 @@ -89,6 +100,9 @@ ghc-options: -funbox-strict-fields -fforce-recomp + -threaded + -rtsopts + -with-rtsopts=-N hs-source-dirs: examples main-is: @@ -108,7 +122,11 @@ primitive, ad, reflection, - tdigest + tdigest, + -- for animation example + diagrams-rasterific, + JuicyPixels, + diagrams-lib default-extensions: NoImplicitPrelude, diff --git a/examples/examples.hs b/examples/examples.hs --- a/examples/examples.hs +++ b/examples/examples.hs @@ -3,6 +3,9 @@ import Chart import NumHask.Prelude +import Codec.Picture.Gif (GifDelay) +import Diagrams.Backend.Rasterific.CmdLine (B, GifOpts(..)) +import Diagrams.Backend.CmdLine (DiagramOpts(..), mainRender) import FakeData @@ -289,6 +292,33 @@ where skinny = Aspect (Rect (V2 ((5*) <$> one) one)) +displayHeader :: FilePath -> [(Diagram B, GifDelay)] -> IO () +displayHeader fn = + mainRender ( DiagramOpts (Just 900) (Just 700) fn + , GifOpts {_dither = False, _noLooping = False, _loopRepeat = Just 2} + ) + +chartRange' :: [[Rect Double]] -> Rect Double +chartRange' = fold . fold + +exampleHistAnim :: Rect Double -> Aspect -> [[Rect Double]] -> Chart' a +exampleHistAnim cr asp rs = + histChartWithRange cr histDefs asp rs <> + axes + ( chartRange .~ Just cr + $ chartAspect .~ asp + $ def) + +exampleAnimation :: FilePath -> IO () +exampleAnimation f = do + xs <- mkHistData + let yss = inits (xs!!0) + let cr = chartRange' yss + let us :: [Diagram B ] + us = exampleHistAnim cr widescreen . pure <$> yss + + displayHeader f $ zip us (repeat (10 :: Int)) + main :: IO () main = do let sOne = (400,400) @@ -322,6 +352,7 @@ fileSvg "other/examplePixels.svg" sOne examplePixels qss <- makeOneDim fileSvg "other/exampleOneDim.svg" (750,150) (exampleOneDim qss) + exampleAnimation "other/anim.gif" scratch (exampleHistCompare (IncludeOvers 1) (hs!!0) (hs!!1)) -- fileSvg "other/scratchpad.svg" (600,150) $ pad 1.1 $ diff --git a/index.html b/index.html new file mode 100644 --- /dev/null +++ b/index.html @@ -0,0 +1,158 @@ + + +

chart-unit Build Status

+

repo

+

chart-unit is an experimental haskell chart library.

+

scratchpad

+

+

unital charting

+

This slowly growing collection of charts:

+ +

charts

+

A chart can be anything that is represented on an XY plane, and usually comes with visual clues about what is being represented, such as axes, titles and legends. Here's the default blank chart:

+
+ + +
+
axes (chartAspect .~ sixbyfour $ chartRange .~ Just one $ def)
+

sixbyfour is a value of type XY, and represents the rectangle that the chart will be rendered with. As with any SVG element, the ultimate product is still subject to sizing on use, so think of sixbyfour as a relative aspect ratio rather than a concrete size.

+

XY

+

chartRange is the range which we would like to plot. chartRange .~ Nothing represents that the range should be whatever the data range is.

+

customization

+

Axes and most other things are highly customizable. Here's another style of chart:

+
+ + +
+

line chart

+

Some actual, real-life lines to be plotted:

+
+ + +
+
lines lineDefs sixbyfour lineData
+

Breaking the code down:

+ +

withChart

+

You don't have to do anything special to combine these lines with axes.

+
+ + +
+
lines lineDefs sixbyfour lineData <> 
+axes (chartRange .~ Just (rangeR2s lineData) $ def)
+

withChart is a convenience function for this common operation, and the code below is equivalent to the above code:

+
withChart def (lines lineDefs) lineData
+

scatter

+

Other default chart types follow this same pattern:

+
+ + +
+
xys <- mkScatterData
+withChart (chartAspect .~ asquare $ def) (scatters scatterDefs) xys
+

As with line, scatter zips together multiple configurations and multiple containers of data. It's often much easier to construct charts assuming multiple data sets.

+

A major point of the chart-unit library is that the look-n-feel of a chart is invariant to the data scale.

+
+ + +
+
let xys1 = fmap (over _x (*1e8) . over _y (*1e-8)) <$> xys in
+withChart (chartAspect .~ asquare $ def) (scatters scatterDefs) xys1
+

histogram

+

A histogram, in widescreen

+
+ + +
+

A histogram, with unequal bin sizes (based on quantiles)

+
+ + +
+

... converted to a line chart

+
+ + +
+

A labelled bar chart:

+
+ + +
+

pixel chart

+

A chart with a color for each XY point in a plane. Close synonyms are probably an area chart, a surface chart. A contour chart must be close.

+
+ + +
+

One-dim chart

+

axes technology can be re-purposed to create skinny charts:

+
+ + +
+

Compound charts

+

chart-unit is a fairly thin wrapper over diagrams that establishes the basics of what a chart is, and provides some sane defaults. From this starting point, production of high-quality charting is easy and pleasant. Some examples:

+

Comparing two histograms.

+
+ + +
+

A scatter chart with histograms of the data along the x & y dimensions.

+
+ + +
+

A unital gradient chart, using diagrams arrows:

+
+ + +
+

The QChart type exists to enable combining different types of charts using the same scale.

+
+ + +
+

Clipping charts

+
+ + +
+

animation

+

+

data

+

Double-containered dimensioned data covers what a chart charts - one or more data sets with at least an x and y dimension (called R2 in the linear library).

+

Most chart variations are about what to do with the extra dimensions in the data. A rectangle, for example, is built from 4 dimensions, an anchoring of position in XY space, with a width (W) and height (Z). A contour map is three dimensional data (V3 in linear), with placement as XY and color as Z.

+

diagrams development recipe

+

In constructing new chart units:

+ +

You can slide up and down the various diagrams abstraction levels creating transformations at each level. For example, here's something I use to work at the point level:

+
unitp f = unitSquare # f # fromVertices # closeTrail # strokeTrail
+

workflow

+

recipe 1

+
scratch :: Chart SVG -> IO ()
+scratch = fileSvg "other/scratchpad.svg" (600,400)
+

I tend to work in ghci a lot, using the above scratch to try code out, mashing the refresh button in the browser. Or I switch on stacks --file-watch ...

+

recipe 2

+
stack build --test --exec "$(stack path --local-install-root)/bin/chart-unit-examples" --exec "$(stack path --local-bin)/pandoc -f markdown+lhs -i app/examples.hs -t html -o index.html --filter pandoc-include --mathjax" --file-watch
diff --git a/readme.md b/readme.md new file mode 100644 --- /dev/null +++ b/readme.md @@ -0,0 +1,23 @@ + +[chart-unit](https://tonyday567.github.io/chart-unit) [![Build Status](https://travis-ci.org/tonyday567/chart-unit.png)](https://travis-ci.org/tonyday567/chart-unit) +=== + +[repo](https://tonyday567.github.com/chart-unit) + +`chart-unit` is an experimental haskell chart library. + +At the moment, only SVG is supported, and github markdown doesn't include support for svg images. + +See https://tonyday567.github.io/chart-unit for a readme. + +compile recipe +-------- + +~~~ +stack build --test --exec "$(stack path --local-install-root)/bin/chart-unit-examples" --exec "$(stack path --local-bin)/pandoc -f markdown+lhs -i app/examples.hs -t html -o index.html --filter pandoc-include --mathjax" --file-watch +~~~ + +to do +--- + +- legends, text (titles, etc) diff --git a/src/Chart/Unit.hs b/src/Chart/Unit.hs --- a/src/Chart/Unit.hs +++ b/src/Chart/Unit.hs @@ -11,10 +11,14 @@ , pixel1 , arrow1 , box - , lineChart , scatterChart + , scatterChartWithRange + , lineChart + , lineChartWithRange , histChart + , histChartWithRange , arrowChart + , arrowChartWithRange , rangeV4 , rangeV42Rect , scaleV4s @@ -148,33 +152,70 @@ lw 0 )) <$> rs --- * charts are recipes for constructing a QDiagram from a specification of the XY plane to be projected on to (XY), a list of traversable vector containers and a list of configurations. - +-- * charts are recipes for constructing a QDiagram from a specification of the XY plane to be projected on to (XY), a list of traversable vector containers and a list of configurations. The charts are self-scaling. +-- | a chart of scattered dot points scaled to its own range scatterChart :: (R2 r, Traversable f) => [ScatterConfig] -> Aspect -> [f (r Double)] -> Chart a -scatterChart defs (Aspect xy) xyss = mconcat $ zipWith scatter1 defs (scaleR2s xy xyss) +scatterChart defs asp xyss = + scatterChartWithRange (foldMap rangeR2 xyss) defs asp xyss +-- | a chart of scattered dot points with a specific range +scatterChartWithRange :: + (R2 r, Traversable f) => + Rect Double -> + [ScatterConfig] -> + Aspect -> + [f (r Double)] -> + Chart a +scatterChartWithRange cr defs (Aspect xy) xyss = + mconcat $ zipWith scatter1 defs (projectR2 cr xy <$> xyss) + +-- | a chart of lines scaled to its own range lineChart :: (R2 r, Traversable f) => [LineConfig] -> Aspect -> [f (r Double)] -> Chart a -lineChart defs (Aspect xy) xyss = mconcat $ zipWith line1 defs (scaleR2s xy xyss) +lineChart defs asp xyss = + lineChartWithRange (foldMap rangeR2 xyss) defs asp xyss +-- | a chart of lines with a specific range +lineChartWithRange :: + (R2 r, Traversable f) => + Rect Double -> + [LineConfig] -> + Aspect -> + [f (r Double)] -> + Chart a +lineChartWithRange cr defs (Aspect xy) xyss = + mconcat $ zipWith line1 defs (projectR2 cr xy <$> xyss) + +-- | a chart of histograms scaled to its own range histChart :: (Traversable f) => [RectConfig] -> Aspect -> [f (Rect Double)] -> Chart a -histChart defs (Aspect xy) rs = - centerXY . mconcat . zipWith rect1 defs $ scaleRectss xy rs +histChart defs asp rs = + histChartWithRange (fold $ fold <$> rs) defs asp rs +-- | a chart of histograms with a specific range +histChartWithRange :: + (Traversable f) => + Rect Double -> + [RectConfig] -> + Aspect -> + [f (Rect Double)] -> + Chart a +histChartWithRange cr defs (Aspect xy) rs = + mconcat . zipWith rect1 defs $ fmap (projectRect cr xy) <$> rs + toPixels :: Rect Double -> (V2 Double -> Double) -> PixelConfig -> [(Rect Double, Color)] toPixels xy f cfg = zip g cs where @@ -187,10 +228,10 @@ rescalePixels :: Rect Double -> [(Rect Double, Color)] -> [(Rect Double, Color)] rescalePixels xy xys = zip vs cs where - vs = scaleRects xy (fst <$> xys) + vs = projectRect (fold $ fst <$> xys) xy . fst <$> xys cs = snd <$> xys --- | pixels over an XY using a function +-- | pixels over an XY plane using a function pixelf :: PixelConfig -> Aspect -> @@ -201,6 +242,16 @@ pixel1 $ rescalePixels asp (toPixels xy f cfg) -- | arrow lengths and sizes also need to be scaled, and so arrows doesnt fit as neatly into the whole scaling idea +arrowChartWithRange :: + (Traversable f) => + V4 (Range Double) -> + ArrowConfig Double -> + V4 (Range Double) -> + f (V4 Double) -> + Chart a +arrowChartWithRange cr cfg xy xs = + arrow1 cfg $ rescaleV4P cr xy <$> xs + arrowChart :: (Traversable f) => ArrowConfig Double -> @@ -208,7 +259,7 @@ f (V4 Double) -> Chart a arrowChart cfg xy xs = - arrow1 cfg $ scaleV4s xy xs + arrow1 cfg $ rescaleV4P (rangeV4 xs) xy <$> xs -- | rescale a V4 from rold to rnew rescaleV4P :: V4 (Range Double) -> V4 (Range Double) -> V4 Double -> V4 Double @@ -254,7 +305,7 @@ withChart conf renderer d = case conf^.chartRange of Nothing -> renderer (conf^.chartAspect) d <> - axes (chartRange .~ Just (rangeR2s d) $ conf) + axes (chartRange .~ Just (foldMap rangeR2 d) $ conf) Just axesRange -> combine (conf ^. chartAspect) [ QChart renderer r d @@ -268,7 +319,7 @@ [] ] where - r = rangeR2s d + r = foldMap rangeR2 d axes :: ChartConfig -> diff --git a/stack.yaml b/stack.yaml new file mode 100644 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,11 @@ +resolver: lts-8.9 + +packages: +- '.' + +extra-deps: +- erf-native-1.0.0.1 +- polynomial-0.7.2 +- tdigest-0.1 +- numhask-0.0.4 +- numhask-range-0.0.3