Data.Graph.Analysis.Reporting

This module defines the report framework used.

Document representation

Document is the simplified representation of a document. Note that this just specifies a document layout, and not an implementation. To actually create a "physical" document, you must use an instance of DocumentGenerator.

data Document

Representation of a document. The document is to be stored in the directory rootDirectory, and the main file is to have a filename of fileFront <.> (docExtension dg), where dg is an instance of DocumentGenerator.

Constructors

Doc

Fields

rootDirectory :: FilePath

Document location

fileFront :: String

graphDirectory :: FilePath

The sub-directory of rootDirectory, where graphs are to be created.

title :: DocInline

Pre-matter

author :: String

date :: String

legend :: [(Either DocGraph DocInline, DocInline)]

Main-matter

content :: [DocElement]

Instances

Eq Document

Ord Document

Read Document

Show Document

class DocumentGenerator dg where

Represents the class of document generators.

Methods

createDocument :: dg -> Document -> IO (Maybe FilePath)

Convert idealised Document values into actual documents, returning the document file created.

docExtension :: dg -> String

The extension of all document-style files created. Note that this doesn't preclude the creation of other files, e.g. images.

Instances

DocumentGenerator PandocDocument

data Location

Representation of a location, either on the internet or locally.

Constructors

Web String

File FilePath

Instances

Eq Location

Ord Location

Read Location

Show Location

data DocElement

Elements of a document.

Constructors

Section DocInline [DocElement]

Paragraph [DocInline]

Enumeration [DocElement]

Itemized [DocElement]

Definitions [(DocInline, DocInline)]

GraphImage DocGraph

Instances

Eq DocElement

Ord DocElement

Read DocElement

Show DocElement

data DocInline

Inline elements of a document.

Constructors

Text String

BlankSpace

Grouping [DocInline]

Bold DocInline

Emphasis DocInline

DocLink DocInline Location

DocImage DocInline Location

Instances

Eq DocInline

Ord DocInline

Read DocInline

Show DocInline

data GraphSize

Specify the size the DotGraph should be at.

Constructors

GivenSize Point

Specify the size to use.

DefaultSize

Let GraphViz choose an appropriate size.

Instances

Eq GraphSize

Ord GraphSize

Read GraphSize

Show GraphSize

data DocGraph

Specify the DotGraph to turn into an image, its filename (sans extension) and its caption. The DotGraph should not have a Size set.

Constructors

DG

Fields

imageFile :: FilePath

What name to provide the image file (without an extension).

description :: DocInline

dotGraph :: DotGraph Node

Instances

Eq DocGraph

Ord DocGraph

Read DocGraph

Show DocGraph

data VisParams

Defines the parameters used for creating visualisations of graphs.

Constructors

VParams

Fields

rootDir :: FilePath

Root directory of the document.

graphDir :: FilePath

Image sub-directory.

defaultImage :: VisProperties

The default visualisation.

largeImage :: Maybe VisProperties

If Just vp', then a larger visualisation is linked to from the default one.

saveDot :: Bool

Should the Dot source code be saved as well?

Instances

Eq VisParams

Ord VisParams

Read VisParams

Show VisParams

data VisProperties

A specification on how to visualise a DocGraph.

Constructors

VProps

Fields

size :: GraphSize

format :: GraphvizOutput

Instances

Eq VisProperties

Ord VisProperties

Read VisProperties

Show VisProperties

Helper functions

Utility functions to help with document creation.

addLegend :: FilePath -> FilePath -> VisProperties -> Document -> IO Document

Create the legend section and add it to the document proper.

today :: IO String

Return today's date as a string, e.g. "Monday 1 January, 2000". This arbitrary format is chosen as there doesn't seem to be a way of determining the correct format as per the user's locale settings.

tryCreateDirectory :: FilePath -> IO Bool

Attempts to create the specified directly, returning True if successful (or if the directory already exists), False if an error occurred.

createGraph

Arguments

:: VisParams

Visualisation parameters.

-> DocGraph

-> IO DocElement

Attempts to create image files (with the given filename in the given directory) from the graph. If the second VisProperties not Nothing, then the first image links to the second. The whole result is wrapped in a Paragraph. unDotPath is applied to the filename in the DocGraph.

If saveDot is true, then it is assumed that the format isn't Canon, DotOutput or XDot (because of filename clashes).

createSize :: Double -> GraphSize

Using a 6:4 ratio, create the given Point representing width,height from the width.

unDotPath :: FilePath -> FilePath

Replace all . with - in the given FilePath, since some output formats (e.g. LaTeX) don't like extraneous .'s in the filename.