diff --git a/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,3 +1,8 @@ +0.2.2 +=== +- chart-svg bump to v0.7 + + 0.2 === - removed gpalette (transferred to chart-svg) diff --git a/prettychart.cabal b/prettychart.cabal --- a/prettychart.cabal +++ b/prettychart.cabal @@ -1,6 +1,6 @@ cabal-version: 3.0 name: prettychart -version: 0.2.0.0 +version: 0.2.2.0 license: BSD-3-Clause license-file: LICENSE copyright: Tony Day (c) 2023 @@ -13,11 +13,14 @@ description: Serve and print charts from ghci, with automatic formatting. build-type: Simple -tested-with: GHC == 8.10.7 || ==9.2.8 || ==9.4.5 || ==9.6.2 || ==9.8.1 +tested-with: + , GHC == 9.10.1 + , GHC == 9.8.2 + , GHC == 9.6.5 extra-doc-files: ChangeLog.md other/*.svg - readme.org + readme.md source-repository head type: git @@ -34,60 +37,7 @@ -Wredundant-constraints common ghc2021-stanza - if impl ( ghc >= 9.2 ) - default-language: GHC2021 - - if impl ( ghc < 9.2 ) - default-language: Haskell2010 - default-extensions: - BangPatterns - BinaryLiterals - ConstrainedClassMethods - ConstraintKinds - DeriveDataTypeable - DeriveFoldable - DeriveFunctor - DeriveGeneric - DeriveLift - DeriveTraversable - DoAndIfThenElse - EmptyCase - EmptyDataDecls - EmptyDataDeriving - ExistentialQuantification - ExplicitForAll - FlexibleContexts - FlexibleInstances - ForeignFunctionInterface - GADTSyntax - GeneralisedNewtypeDeriving - HexFloatLiterals - ImplicitPrelude - InstanceSigs - KindSignatures - MonomorphismRestriction - MultiParamTypeClasses - NamedFieldPuns - NamedWildCards - NumericUnderscores - PatternGuards - PolyKinds - PostfixOperators - RankNTypes - RelaxedPolyRec - ScopedTypeVariables - StandaloneDeriving - StarIsType - TraditionalRecordSyntax - TupleSections - TypeApplications - TypeOperators - TypeSynonymInstances - - if impl ( ghc < 9.2 ) && impl ( ghc >= 8.10 ) - default-extensions: - ImportQualifiedPost - StandaloneKindSignatures + default-language: GHC2021 library import: ghc-options-stanza @@ -98,16 +48,26 @@ , base >=4.7 && <5 , box >=0.9 && <0.10 , bytestring >=0.11.3 && <0.13 - , chart-svg >=0.6 && <0.7 + , chart-svg >=0.6 && <0.8 , containers >=0.6 && <0.8 , markup-parse >=0.1 && <0.2 , numhask-space >=0.10 && <0.12 , optics-core >=0.4 && <0.5 , text >=1.2 && <2.2 - , time >=1.9 && <1.13 + , time >=1.9 && <1.15 , web-rep >=0.12.1 && <0.13 exposed-modules: Prettychart Prettychart.Any Prettychart.Charts Prettychart.Server + +test-suite doctests + import: ghc2021-stanza + main-is: doctests.hs + hs-source-dirs: test + build-depends: + , base >=4.14 && <5 + , doctest-parallel >=0.3 && <0.4 + ghc-options: -threaded + type: exitcode-stdio-1.0 diff --git a/readme.md b/readme.md new file mode 100644 --- /dev/null +++ b/readme.md @@ -0,0 +1,268 @@ + +# Table of Contents + +1. [prettychart](#org52eda08) +2. [Usage](#orgf05409a) + 1. [live coding](#org062de09) + 2. [ghci integration](#orgfcd7bd6) +3. [Development](#orgf489981) + 1. [live](#org2deed6a) +4. [Prettychart.Any Examples](#orgca9d9d6) + 1. [single list](#org9b83b20) + 1. [10 or less elements => bar chart](#orgc860033) + 2. [>1000 elements => histogram](#org7abe64c) + 3. [< 1000 && > 10 => line chart](#orga634aff) + 2. [double list](#org493d2b1) + 1. [< 4 lists && < 10 values per list => bar chart](#org6e7fcb7) + 2. [square => surface chart](#org5e9ba1b) + 3. [tuple list [(Double, Double)] => scatter](#orgfc9b845) + 4. [double tuple list [(Double, Double)] => scatter](#orgcd245d1) + 5. [(Text, Double) tuple list](#org5cb6f57) + + + + +# prettychart + +[![img](https://img.shields.io/hackage/v/prettychart.svg)](https://hackage.haskell.org/package/prettychart) [![img](https://github.com/tonyday567/prettychart/workflows/haskell-ci/badge.svg)](https://github.com/tonyday567/chart-svg/actions?query=workflow%3Ahaskell-ci) + +This library contains: + +- A chart server, for use in conjunction with ghci, or other live coding situations. (See Chartpretty.Server) +- anyChart, which attempts to convert text (of numbers) to a chart. (See Chartpretty.Any) +- Some useful chart patterns that didn’t make the cut in chart-svg (See Chartpretty.Charts) + + + + +# Usage + + + + +## live coding + +The server can be used to view and develop chart-svg charts. + + > (display, quit) <- startChartServer (Just "prettychart") + Setting phaser>s to stun... (port 9160) (ctrl-c to quit) + + -- open localhost:9160 + -- developing and sending a chart to the server + + > import Chart.Examples + > display lineExample + + > quit + + + + +## ghci integration + +Add this to your .ghci.conf file to automatically go into :prettychart mode. + + -- :set -package prettychart + :{ + :def! prettychart \_ -> pure $ unlines [ + "import Prettychart", + "(sendChart, quitChartServer) <- startChartServer Nothing", + "printc=printChart False sendChart", + ":set -interactive-print printc" + ] + :} + + :{ + :def! noprettychart \_ -> pure $ unlines [ + "quitChartServer", + ":set -interactive-print print" + ] + :} + + :prettychart + + ghci| ghci| ghci| ghci| ghci| ghci| ghci| + > ghci| ghci| ghci| ghci| ghci| + > Setting phasers to stun... (port 9160) (ctrl-c to quit) + + [1..200] + + :noprettychart + + + + +# Development + + :r + :set prompt "> " + :set -Wno-type-defaults + :set -Wno-name-shadowing + :set -XOverloadedStrings + :set -XTupleSections + :set -XOverloadedLabels + import Chart hiding (quantiles) + import Chart.Examples + import Optics.Core + import Prettychart.Charts + import Prettychart.Any + import Prettychart.ExampleData + import Prettychart.Server + import Data.Time.Calendar + import qualified Data.Map as Map + import Data.Text (Text,pack) + import qualified Data.Text as Text + import qualified Data.Text.IO as Text + import Data.Time + import qualified Data.List as List + import Control.Category ((>>>)) + print "ok" + + [3 of 5] Compiling Prettychart.ExampleData ( src/Prettychart/ExampleData.hs, interpreted ) [Flags changed] + [5 of 5] Compiling Prettychart ( src/Prettychart.hs, interpreted ) [Flags changed] + Ok, five modules loaded. + > + ok + + + + +## live + + (display, quit) <- startChartServer Nothing + + display $ debugExample quadExample + + True + + + + +# Prettychart.Any Examples + + + + +## single list + + + + +### 10 or less elements => bar chart + + xs = [0..9] + + either Text.putStrLn (writeChartOptions "other/list1a.svg") $ anyChart (pack . show $ xs) + +![img](other/list1a.svg) + + either Text.putStrLn (writeChartOptions "other/list1a.svg") $ anyChart (pack . show $ xs) + + + + +### >1000 elements => histogram + + xs = sin <$> [0..2000] + + either Text.putStrLn (writeChartOptions "other/list1b.svg") $ anyChart (pack . show $ xs) + +![img](other/list1b.svg) + + + + +### < 1000 && > 10 => line chart + +In between goes for a line chartIn between goes for a line chart. + + xs = sin . (/100) <$> [0..500] + + either Text.putStrLn (writeChartOptions "other/list1c.svg") $ anyChart (pack . show $ xs) + +![img](other/list1c.svg) + + + + +## double list + + + + +### < 4 lists && < 10 values per list => bar chart + + xs = [(1+) . sin <$> [0..8], (1+) . cos <$> [0..8]] + xs + + [[1.0,1.8414709848078965,1.9092974268256817,1.1411200080598671,0.2431975046920718,4.1075725336861546e-2,0.7205845018010741,1.656986598718789,1.989358246623382],[2.0,1.5403023058681398,0.5838531634528576,1.0007503399554585e-2,0.34635637913638806,1.2836621854632262,1.960170286650366,1.7539022543433047,0.8544999661913865]] + + either Text.putStrLn (writeChartOptions "other/dlista.svg") $ anyChart (pack . show $ xs) + +![img](other/dlista.svg) + + + + +### square => surface chart + + iter2 f xs ys = f <$> xs <&> flip fmap ys -- or (\a -> f a <$> ys) <$> xs + xs = iter2 (*) (fmap sin [1..20]) (fmap cos [1..20]) :: [[Double]] + :t xs + length xs + fmap length xs + + xs :: [[Double]] + 20 + [20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20] + + either Text.putStrLn (writeChartOptions "other/dlistb.svg") $ anyChart (pack . show $ xs) + +![img](other/dlistb.svg) + + + + +## tuple list [(Double, Double)] => scatter + + xs = zip (fmap (sin . (0.06*)) [1..100]) (fmap (cos . (0.06*)) [1..100]) + :t xs + + xs + :: (TrigField b1, TrigField b2, Fractional b1, Fractional b2, + Enum b1, Enum b2) => + [(b1, b2)] + + either Text.putStrLn (writeChartOptions "other/dtuple.svg") $ anyChart (pack . show $ xs) + +![img](other/dtuple.svg) + + + + +## double tuple list [(Double, Double)] => scatter + + iter2 f xs ys = f <$> xs <&> flip fmap ys -- or (\a -> f a <$> ys) <$> xs + + + xs = iter2 (\s (x,y) -> (s*x, s*y)) ((0.1*) <$> [1..10]) (zip (fmap (sin . (0.06*)) [1..100]) (fmap (cos . (0.06*)) [1..100])) + :t xs + + > > + xs :: (Fractional b, Enum b, TrigField b) => [[(b, b)]] + + either Text.putStrLn (writeChartOptions "other/dtupleb.svg") $ anyChart (pack . show $ xs) + +![img](other/dtupleb.svg) + + + + +## (Text, Double) tuple list + + xs = (\x -> (show x, x)) <$> [0..9] + + either Text.putStrLn (writeChartOptions "other/tdtuple.svg") $ anyChart (pack . show $ xs) + +![img](other/tdtuple.svg) + diff --git a/readme.org b/readme.org deleted file mode 100644 --- a/readme.org +++ /dev/null @@ -1,268 +0,0 @@ -* prettychart - -[[https://hackage.haskell.org/package/prettychart][https://img.shields.io/hackage/v/prettychart.svg]] [[https://github.com/tonyday567/chart-svg/actions?query=workflow%3Ahaskell-ci][file:https://github.com/tonyday567/prettychart/workflows/haskell-ci/badge.svg]] - -This library contains: - -- A chart server, for use in conjunction with ghci, or other live coding situations. (See Chartpretty.Server) -- anyChart, which attempts to convert text (of numbers) to a chart. (See Chartpretty.Any) -- Some useful chart patterns that didn't make the cut in chart-svg (See Chartpretty.Charts) - -* Usage -** live coding - -The server can be used to view and develop chart-svg charts. - -#+begin_src haskell :results output -> (display, quit) <- startChartServer (Just "prettychart") -Setting phaser>s to stun... (port 9160) (ctrl-c to quit) - --- open localhost:9160 --- developing and sending a chart to the server - -> import Chart.Examples -> display lineExample - -> quit - -#+end_src - -** ghci integration - -Add this to your .ghci.conf file to automatically go into :prettychart mode. - -#+begin_src haskell :results output --- :set -package prettychart -:{ -:def! prettychart \_ -> pure $ unlines [ - "import Prettychart", - "(sendChart, quitChartServer) <- startChartServer Nothing", - "printc=printChart False sendChart", - ":set -interactive-print printc" - ] -:} - -:{ -:def! noprettychart \_ -> pure $ unlines [ - "quitChartServer", - ":set -interactive-print print" - ] -:} - -:prettychart -#+end_src - -#+RESULTS: -: ghci| ghci| ghci| ghci| ghci| ghci| ghci| -: > ghci| ghci| ghci| ghci| ghci| -: > Setting phasers to stun... (port 9160) (ctrl-c to quit) - -#+begin_src haskell :results output -[1..200] -#+end_src - -#+RESULTS: - -#+begin_src haskell :results output -:noprettychart -#+end_src - -* Development - -#+begin_src haskell :results output -:r -:set prompt "> " -:set -Wno-type-defaults -:set -Wno-name-shadowing -:set -XOverloadedStrings -:set -XTupleSections -:set -XOverloadedLabels -import Chart hiding (quantiles) -import Chart.Examples -import Optics.Core -import Prettychart.Charts -import Prettychart.Any -import Prettychart.ExampleData -import Prettychart.Server -import Data.Time.Calendar -import qualified Data.Map as Map -import Data.Text (Text,pack) -import qualified Data.Text as Text -import qualified Data.Text.IO as Text -import Data.Time -import qualified Data.List as List -import Control.Category ((>>>)) -print "ok" -#+end_src - -#+RESULTS: -: [3 of 5] Compiling Prettychart.ExampleData ( src/Prettychart/ExampleData.hs, interpreted ) [Flags changed] -: [5 of 5] Compiling Prettychart ( src/Prettychart.hs, interpreted ) [Flags changed] -: Ok, five modules loaded. -: > -: ok - -** live -#+begin_src haskell :results output -(display, quit) <- startChartServer Nothing -#+end_src - -#+RESULTS: - -#+begin_src haskell :results output -display $ debugExample quadExample -#+end_src - -#+RESULTS: -: True - -* Prettychart.Any Examples -** single list - -*** 10 or less elements => bar chart - -#+begin_src haskell -xs = [0..9] -#+end_src - -#+RESULTS: - -#+begin_src haskell :file other/list1a.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/list1a.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/list1a.svg]] - -#+begin_src haskell :results output -either Text.putStrLn (writeChartOptions "other/list1a.svg") $ anyChart (pack . show $ xs) -#+end_src - -*** >1000 elements => histogram - -#+begin_src haskell -xs = sin <$> [0..2000] -#+end_src - -#+RESULTS: - -#+begin_src haskell :file other/list1b.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/list1b.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/list1b.svg]] - -*** < 1000 && > 10 => line chart - -In between goes for a line chartIn between goes for a line chart. - -#+begin_src haskell -xs = sin . (/100) <$> [0..500] -#+end_src - -#+begin_src haskell :file other/list1c.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/list1c.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/list1c.svg]] - -** double list -*** < 4 lists && < 10 values per list => bar chart - - -#+begin_src haskell :results output -xs = [(1+) . sin <$> [0..8], (1+) . cos <$> [0..8]] -xs -#+end_src - -#+RESULTS: -: [[1.0,1.8414709848078965,1.9092974268256817,1.1411200080598671,0.2431975046920718,4.1075725336861546e-2,0.7205845018010741,1.656986598718789,1.989358246623382],[2.0,1.5403023058681398,0.5838531634528576,1.0007503399554585e-2,0.34635637913638806,1.2836621854632262,1.960170286650366,1.7539022543433047,0.8544999661913865]] - -#+begin_src haskell :file other/dlista.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/dlista.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/dlista.svg]] - -*** square => surface chart - -#+begin_src haskell :results output -iter2 f xs ys = f <$> xs <&> flip fmap ys -- or (\a -> f a <$> ys) <$> xs -xs = iter2 (*) (fmap sin [1..20]) (fmap cos [1..20]) :: [[Double]] -:t xs -length xs -fmap length xs -#+end_src - -#+RESULTS: -: xs :: [[Double]] -: 20 -: [20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20,20] - - -#+begin_src haskell :file other/dlistb.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/dlistb.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/dlistb.svg]] - -** tuple list [(Double, Double)] => scatter - -#+begin_src haskell :results output -xs = zip (fmap (sin . (0.06*)) [1..100]) (fmap (cos . (0.06*)) [1..100]) -:t xs -#+end_src - -#+RESULTS: -: xs -: :: (TrigField b1, TrigField b2, Fractional b1, Fractional b2, -: Enum b1, Enum b2) => -: [(b1, b2)] - -#+begin_src haskell :file other/dtuple.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/dtuple.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/dtuple.svg]] - -** double tuple list [(Double, Double)] => scatter - - -#+begin_src haskell :results output -iter2 f xs ys = f <$> xs <&> flip fmap ys -- or (\a -> f a <$> ys) <$> xs - - -xs = iter2 (\s (x,y) -> (s*x, s*y)) ((0.1*) <$> [1..10]) (zip (fmap (sin . (0.06*)) [1..100]) (fmap (cos . (0.06*)) [1..100])) -:t xs -#+end_src - -#+RESULTS: -: > > -: xs :: (Fractional b, Enum b, TrigField b) => [[(b, b)]] - -#+begin_src haskell :file other/dtupleb.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/dtupleb.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/dtupleb.svg]] - -** (Text, Double) tuple list - -#+begin_src haskell -xs = (\x -> (show x, x)) <$> [0..9] -#+end_src - -#+RESULTS: -#+begin_src haskell :file other/tdtuple.svg :results output graphics file :exports both -either Text.putStrLn (writeChartOptions "other/tdtuple.svg") $ anyChart (pack . show $ xs) -#+end_src - -#+RESULTS: -[[file:other/tdtuple.svg]] - diff --git a/src/Prettychart/Charts.hs b/src/Prettychart/Charts.hs --- a/src/Prettychart/Charts.hs +++ b/src/Prettychart/Charts.hs @@ -69,8 +69,7 @@ & #ticks % #tick .~ TickPlaced - ( first (* fromIntegral (length ds)) <$> placedTimeLabelContinuous PosInnerOnly Nothing nticks (unsafeSpace1 ds) - ) + (first (* fromIntegral (length ds)) <$> placedTimeLabelContinuous PosInnerOnly Nothing nticks (unsafeSpace1 ds)) -- | common pattern of chart title, x-axis title and y-axis title titles3 :: Double -> (Text, Text, Text) -> [Priority TitleOptions] diff --git a/test/doctests.hs b/test/doctests.hs new file mode 100644 --- /dev/null +++ b/test/doctests.hs @@ -0,0 +1,7 @@ +module Main where + +import System.Environment (getArgs) +import Test.DocTest (mainFromCabal) + +main :: IO () +main = mainFromCabal "prettychart" =<< getArgs