Documentation

Find an executable.

List of toolkits available on this machine. The executables to look for are taken from the configuration.

List of toolkits not available on this machine. The executables to look for are taken from the configur

Save formats supported by this renderer.

Get the renderer associated with a toolkit. If the renderer has not been used before, initialize it and store where it is. It will be re-used.

The function that maps from configuration to the preamble.

Parse code block headers for extra attributes that are specific to this renderer. By default, no extra attributes are parsed.

Monadic version of availableToolkits.

Note that logging is disabled

Monadic version of unavailableToolkits

Internal description of all information needed to output a figure.

Executable program, and sometimes the directory where it can be found.

Possible result of running a script

Determine the path a figure should have. The path for this file is unique to the content of the figure, so that figurePath can be used to determine whether a figure should be rendered again or not.

Determine the path to the source code that generated the figure. To ensure that the source code path is distinguished from HTML figures, we use the extension .src.html.

Determine inclusion specifications from Block attributes. If an environment is detected, but the save format is incompatible, an error will be thrown.

Determine which toolkit should be used to render the plot from a code block, if any.

Reader a caption, based on input document format

Read configuration from a YAML file. The keys are exactly the same as for code blocks.

If a key is not present, its value will be set to the default value. Parsing errors result in thrown exceptions.

Default configuration values.

Since: 0.5.0.0

Extact path to configuration from the metadata in a Pandoc document. The path to the configuration file should be under the plot-configuration key. In case there is no such metadata, return the default configuration.

For example, at the top of a markdown file:

---
title: My document
author: John Doe
plot-configuration: pathto/file.yml
---

The same can be specified via the command line using Pandoc's -M flag:

pandoc --filter pandoc-plot -M plot-configuration="path/to/file.yml" ...

Since: 0.6.0.0

Clean all output related to pandoc-plot. This includes output directories specified in the configuration and in the document/block, as well as log files. Note that *all* files in pandoc-plot output directories will be removed.

The cleaned directories are returned.

Analyze a document to determine where would the pandoc-plot output directories be.

Read a document, guessing what extensions and reader options are appropriate. If the file cannot be read for any reason, an error is thrown.

Datatype containing all parameters required to specify a figure.

It is assumed that once a FigureSpec has been created, no configuration can overload it; hence, a FigureSpec completely encodes a particular figure.

Verbosity of the logger.

Lift a computation from the IO monad. This allows us to run IO computations in any monadic stack, so long as it supports these kinds of operations (i.e. IO is the base monad for the stack).

Example

import Control.Monad.Trans.State -- from the "transformers" library

printState :: Show s => StateT s IO ()
printState = do
  state <- get
  liftIO $ print state

• Couldn't match type ‘IO’ with ‘StateT s IO’
 Expected type: StateT s IO ()
   Actual type: IO ()

> evalStateT printState "hello"
"hello"

> evalStateT printState 3
3

Retrieves the monad environment.

Retrieves a function of the current environment.

Run a command within the PlotM monad. Stderr stream is read and decoded, while Stdout is ignored. Logging happens at the debug level if the command succeeds, or at the error level if it does not succeed.

Class name which will trigger the filter

Find an executable.

Generated figure file format supported by pandoc-plot. Note that not all formats are supported by all toolkits.

The Configuration type holds the default values to use when running pandoc-plot. These values can be overridden in code blocks.

You can create an instance of the Configuration type from file using the configuration function.

You can store the path to a configuration file in metadata under the key plot-configuration. For example, in Markdown:

    ---
    title: My document
    author: John Doe
    plot-configuration: pathtofile.yml
    ---

The same can be specified via the command line using Pandoc's -M flag:

pandoc --filter pandoc-plot -M plot-configuration="path/to/file.yml" ...

In this case, use configurationPathMeta to extact the path from Pandoc documents.

Description of the possible ways to sink log messages.

Source context for plotting scripts

Enumeration of supported toolkits

List of supported toolkits.

pandoc-plot monad

Get access to configuration within the PlotM monad.

maps a function, performing at most N actions concurrently.

Evaluate a PlotM action.

Throw an error that halts the execution of pandoc-plot due to a strict-mode.

Internal description of all information needed to output a figure.

Executable program, and sometimes the directory where it can be found.

Prepend a directory to the PATH environment variable for the duration of a computation.

This function is exception-safe; even if an exception happens during the computation, the PATH environment variable will be reverted back to its initial value.

Get a filehash. If the file hash has been computed before, it is reused. Otherwise, the filehash is calculated and stored.

Result of checking scripts for problems

Description of any possible inclusion key, both in documents and in configuration files.

Save format file extension

List of all keys related to pandoc-plot that can be specified in source material.

Convert a FigureSpec to a Pandoc figure component. Note that the script to generate figure files must still be run in another function.

Extract the plot-relevant content from inside of a full HTML document. Scripts contained in the head tag are extracted, as well as the entirety of the body tag.