ploterific-0.2.1.4: Basic plotting of tabular data for the command line.
Safe HaskellNone
LanguageHaskell2010

Ploterific.Program.Options

Synopsis
  • data Options = Options {
    • input :: Maybe String <?> "([STDIN] | PATH) The path for the input data in tabular format, with row observations and column features."
    • output :: Maybe String <?> "([STDOUT] | PATH) HTML output path."
    • feature :: [String] <?> "(COLUMN) A list of columns to use in the plot in the format --feature col1 --feature col2 etc. for axes X, Y, etc. To force a measurement, add `:` followed by `N`, `O`, `Q`, or `T` for nominal, ordinal, quantitiative, or temporal measurements, respectively. Full list of measurements located at https://vega.github.io/vega-lite/docs/type.html."
    • facet :: Maybe String <?> "(NOTHING | COLUMN) The column containing a feature to use to facet a plot into a Trellis plot. Add measurement according to --feature if needed."
    • facetNum :: Maybe Int <?> "(NOTHING | INT) The number of columns for the Trellis plot from --facet."
    • color :: Maybe String <?> "(NOTHING | COLUMN) The column containing a feature to use for colors. Add measurement according to --feature if needed."
    • mark :: String <?> "(MARK) The mark type for the plot. Common types are Circle, Bar, Boxplot, and Line. See https://hackage.haskell.org/package/hvega-0.11.0.1/docs/Graphics-Vega-VegaLite.html#t:Mark for a list."
    • delimiter :: Maybe Char <?> "([,] | CHAR) The delimiter for the table."
    • height :: Maybe Double <?> "(Nothing | DOUBLE) The height of the plot."
    • width :: Maybe Double <?> "(Nothing | Double) The width of the plot."
    • defaultTheme :: Bool <?> "Whether to use the default theme of vega-lite."
    }
  • modifiers :: Modifiers

Documentation

data Options Source #

Command line arguments

Constructors

Options 

Fields

  • input :: Maybe String <?> "([STDIN] | PATH) The path for the input data in tabular format, with row observations and column features."
     
  • output :: Maybe String <?> "([STDOUT] | PATH) HTML output path."
     
  • feature :: [String] <?> "(COLUMN) A list of columns to use in the plot in the format --feature col1 --feature col2 etc. for axes X, Y, etc. To force a measurement, add `:` followed by `N`, `O`, `Q`, or `T` for nominal, ordinal, quantitiative, or temporal measurements, respectively. Full list of measurements located at https://vega.github.io/vega-lite/docs/type.html."
     
  • facet :: Maybe String <?> "(NOTHING | COLUMN) The column containing a feature to use to facet a plot into a Trellis plot. Add measurement according to --feature if needed."
     
  • facetNum :: Maybe Int <?> "(NOTHING | INT) The number of columns for the Trellis plot from --facet."
     
  • color :: Maybe String <?> "(NOTHING | COLUMN) The column containing a feature to use for colors. Add measurement according to --feature if needed."
     
  • mark :: String <?> "(MARK) The mark type for the plot. Common types are Circle, Bar, Boxplot, and Line. See https://hackage.haskell.org/package/hvega-0.11.0.1/docs/Graphics-Vega-VegaLite.html#t:Mark for a list."
     
  • delimiter :: Maybe Char <?> "([,] | CHAR) The delimiter for the table."
     
  • height :: Maybe Double <?> "(Nothing | DOUBLE) The height of the plot."
     
  • width :: Maybe Double <?> "(Nothing | Double) The width of the plot."
     
  • defaultTheme :: Bool <?> "Whether to use the default theme of vega-lite."
     

Instances

Instances details
Generic Options Source # 
Instance details

Defined in Ploterific.Program.Options

Associated Types

type Rep Options :: Type -> Type #

Methods

from :: Options -> Rep Options x #

to :: Rep Options x -> Options #

ParseRecord Options Source # 
Instance details

Defined in Ploterific.Program.Options

Methods

parseRecord :: Parser Options #

type Rep Options Source # 
Instance details

Defined in Ploterific.Program.Options

type Rep Options = D1 ('MetaData "Options" "Ploterific.Program.Options" "ploterific-0.2.1.4-8Nj49D5nId0KwhmzGH1vYR" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) (((S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String <?> "([STDIN] | PATH) The path for the input data in tabular format, with row observations and column features.")) :*: S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String <?> "([STDOUT] | PATH) HTML output path."))) :*: (S1 ('MetaSel ('Just "feature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ([String] <?> "(COLUMN) A list of columns to use in the plot in the format --feature col1 --feature col2 etc. for axes X, Y, etc. To force a measurement, add `:` followed by `N`, `O`, `Q`, or `T` for nominal, ordinal, quantitiative, or temporal measurements, respectively. Full list of measurements located at https://vega.github.io/vega-lite/docs/type.html.")) :*: (S1 ('MetaSel ('Just "facet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String <?> "(NOTHING | COLUMN) The column containing a feature to use to facet a plot into a Trellis plot. Add measurement according to --feature if needed.")) :*: S1 ('MetaSel ('Just "facetNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int <?> "(NOTHING | INT) The number of columns for the Trellis plot from --facet."))))) :*: ((S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String <?> "(NOTHING | COLUMN) The column containing a feature to use for colors. Add measurement according to --feature if needed.")) :*: (S1 ('MetaSel ('Just "mark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (String <?> "(MARK) The mark type for the plot. Common types are Circle, Bar, Boxplot, and Line. See https://hackage.haskell.org/package/hvega-0.11.0.1/docs/Graphics-Vega-VegaLite.html#t:Mark for a list.")) :*: S1 ('MetaSel ('Just "delimiter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Char <?> "([,] | CHAR) The delimiter for the table.")))) :*: (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double <?> "(Nothing | DOUBLE) The height of the plot.")) :*: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double <?> "(Nothing | Double) The width of the plot.")) :*: S1 ('MetaSel ('Just "defaultTheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Bool <?> "Whether to use the default theme of vega-lite.")))))))

modifiers :: Modifiers Source #