diff --git a/Data/Distribution/Plot.hs b/Data/Distribution/Plot.hs new file mode 100644 --- /dev/null +++ b/Data/Distribution/Plot.hs @@ -0,0 +1,219 @@ +{- Copyright 2014 Romain Edelmann + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. -} + + +-- | This module provides functions to plot distributions to files. +module Data.Distribution.Plot + ( -- * Plotting + plot + , plotWith + -- ** Options + , PlotOptions (..) + -- ** Lenses + , plot_aggregator + , plot_title + , plot_labels + , plot_colors + , plot_displayer + , plot_dimensions + , plot_format + , plot_extra_domain + , plot_stacked + , plot_inversed + ) where + +import Graphics.Rendering.Chart +import Graphics.Rendering.Chart.Backend.Cairo +import Data.Colour +import Data.Colour.Names +import Data.Default.Class +import Data.List (transpose) +import Data.Monoid +import Data.Ratio +import Data.Set (Set) +import qualified Data.Set as Set +import Control.Arrow (second) +import Control.Lens +import Control.Monad (void) + +import Data.Distribution.Aggregator +import Data.Distribution.Core +import Data.Distribution.Measure + +-- | Options for plotting distributions. +data PlotOptions a = PlotOptions + { getAggregator :: Aggregator a + -- ^ Aggregator to apply on the values. + -- Defaults to identity. + , getTitle :: String + -- ^ Title of the plot. + -- Defaults to the empty string. + , getLabels :: [String] + -- ^ Labels of the distributions. + -- Defaults to @[]@. + , getColors :: [AlphaColour Double] + -- ^ Colors for the distributions. + -- Defaults to 'defaultColorSeq'. + , getDisplayer :: a -> String + -- ^ How to display the values. + -- Defaults to @show@. + , getDimensions :: (Int, Int) + -- ^ Dimension of the output image. + -- Defaults to @(600, 400)@. + , getFormat :: FileFormat + -- ^ Format of the output image. + -- Defaults to @PNG@. + , getExtraDomain :: Set a + -- ^ Values to display unconditionally. + -- Defaults to the empty set. + , getStacked :: Bool + -- ^ Whether to stack bars. + -- Defaults to @False@. + , getInversed :: Bool + -- ^ @True@ to put distributions on the x-axis, + -- @False@ to put values on the x-axis. + -- Defaults to @False@. + } + +instance Show a => Default (PlotOptions a) where + def = PlotOptions + { getAggregator = mempty + , getTitle = "" + , getLabels = [] + , getColors = defaultColorSeq + , getDisplayer = show + , getDimensions = (600, 400) + , getFormat = PNG + , getExtraDomain = Set.empty + , getStacked = False + , getInversed = False } + + +-- Lenses + + +-- | Lens for 'getAggregator'. +plot_aggregator :: Simple Lens (PlotOptions a) (Aggregator a) +plot_aggregator = lens getAggregator (\ o x -> o { getAggregator = x }) + +-- | Lens for 'getTitle'. +plot_title :: Simple Lens (PlotOptions a) String +plot_title = lens getTitle (\ o x -> o { getTitle = x }) + +-- | Lens for 'getLabels'. +plot_labels :: Simple Lens (PlotOptions a) [String] +plot_labels = lens getLabels (\ o x -> o { getLabels = x }) + +-- | Lens for 'getColors'. +plot_colors :: Simple Lens (PlotOptions a) [AlphaColour Double] +plot_colors = lens getColors (\ o x -> o { getColors = x }) + +-- | Lens for 'getDisplayer'. +plot_displayer :: Simple Lens (PlotOptions a) (a -> String) +plot_displayer = lens getDisplayer (\ o x -> o { getDisplayer = x }) + +-- | Lens for 'getDisplayer'. +plot_dimensions :: Simple Lens (PlotOptions a) (Int, Int) +plot_dimensions = lens getDimensions (\ o x -> o { getDimensions = x }) + +-- | Lens for 'getFormat'. +plot_format :: Simple Lens (PlotOptions a) FileFormat +plot_format = lens getFormat (\ o x -> o { getFormat = x }) + +-- | Lens for 'getExtraDomain'. +plot_extra_domain :: Simple Lens (PlotOptions a) (Set a) +plot_extra_domain = lens getExtraDomain (\ o x -> o { getExtraDomain = x }) + +-- | Lens for 'getStacked'. +plot_stacked :: Simple Lens (PlotOptions a) Bool +plot_stacked = lens getStacked (\ o x -> o { getStacked = x }) + +-- | Lens for 'getInversed'. +plot_inversed :: Simple Lens (PlotOptions a) Bool +plot_inversed = lens getInversed (\ o x -> o { getInversed = x }) + + +-- Plotting + + +-- | Plots the given distributions to PNG file. +-- +-- See 'plotWith' for more options. +plot :: (Show a, Ord a) => FilePath -> [Distribution a] -> IO () +plot = plotWith def + + +-- | Plots the given distributions to a file. +plotWith :: Ord a => PlotOptions a -> FilePath -> [Distribution a] -> IO () +plotWith options file distributions = void $ renderableToFile env + (if getInversed options then inversed else normal) file + where + env = fo_format .~ getFormat options + $ fo_size .~ getDimensions options + $ def + + baseLayout = layout_title .~ getTitle options + $ layout_title_style . font_size .~ 10 + $ layout_y_axis . laxis_override .~ + (axis_labels %~ map (map (second (++ "%")))) + $ layout_left_axis_visibility . axis_show_ticks .~ False + $ def :: Layout PlotIndex Double + + domain = Set.toAscList + $ Set.unions + $ (:) (getExtraDomain options) + $ map support distributions + + baseBars = plot_bars_spacing .~ BarsFixGap 30 30 + $ plot_bars_item_styles .~ map makeStyle + (cycle $ getColors options) + $ plot_bars_style .~ barStyle + $ def + where + makeStyle c = (solidFillStyle c, Nothing) + barStyle = if getStacked options then BarsStacked else BarsClustered + + normal = toRenderable layout + where + xvalues = domain + + yvalues = transpose $ map + (modifyProbabilities (getAggregator options) . zip xvalues + . \ d -> map (`probabilityAt` d) xvalues) distributions + + layout = layout_x_axis . laxis_generate .~ autoIndexAxis + (map (getDisplayer options) xvalues) + $ layout_plots .~ [ plotBars bars ] + $ baseLayout + + bars = plot_bars_values .~ addIndexes + (map (map (fromRational . (* 100) . toRational)) yvalues) + $ plot_bars_titles .~ getLabels options + $ baseBars + + inversed = toRenderable layout + where + xvalues = getLabels options + + yvalues = map (modifyProbabilities (getAggregator options) . + zip domain . \ d -> map (`probabilityAt` d) domain) distributions + + layout = layout_x_axis . laxis_generate .~ autoIndexAxis xvalues + $ layout_plots .~ [ plotBars bars ] + $ baseLayout + + bars = plot_bars_values .~ addIndexes + (map (map (fromRational . (* 100) . toRational)) yvalues) + $ plot_bars_titles .~ map (getDisplayer options) domain + $ baseBars diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/distribution-plot.cabal b/distribution-plot.cabal new file mode 100644 --- /dev/null +++ b/distribution-plot.cabal @@ -0,0 +1,64 @@ +-- Initial haskell-distribution-plot.cabal generated by cabal init. For +-- further documentation, see http://haskell.org/cabal/users-guide/ + +-- The name of the package. +name: distribution-plot + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 1.0.0.0 + +-- A short (one-line) description of the package. +synopsis: Easily plot distributions from the distribution package.. + +-- A longer description of the package. +-- description: + +-- URL for the project homepage or repository. +homepage: https://github.com/redelmann/haskell-distribution-plot + +-- The license under which the package is released. +license: Apache-2.0 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: Romain Edelmann + +-- An email address to which users can send suggestions, bug reports, and +-- patches. +maintainer: romain.edelmann@gmail.com + +-- A copyright notice. +-- copyright: + +category: Math + +build-type: Simple + +-- Constraint on the version of Cabal needed to build this package. +cabal-version: >=1.8 + + +library + -- Modules exported by the library. + exposed-modules: Data.Distribution.Plot + + -- Modules included in this library but not exported. + -- other-modules: + + -- Other library packages from which modules are imported. + build-depends: base >=4.5 && <5, + Chart ==1.2.*, + Chart-cairo ==1.2.*, + colour ==2.3.*, + data-default-class ==0.0.*, + containers ==0.5.*, + lens ==4.2.*, + distribution ==1.0.* +