Copyright	(c) Dominik Schrempf 2020
License	GPL-3.0-or-later
Maintainer	dominik.schrempf@gmail.com
Stability	unstable
Portability	portable
Safe Haskell	None
Language	Haskell2010

TLynx.Coalesce.Options

Description

Creation date: Fri May 3 11:51:07 2019.

Synopsis

data CoalesceArguments = CoalesceArguments {
- argsNTrees :: Int
- argsNLeaves :: Int
- argsRho :: Maybe Double
- argsSumStat :: Bool
- argsSeed :: Seed
}
coalesceArguments :: Parser CoalesceArguments
reportCoalesceArguments :: CoalesceArguments -> String
coalesceFooter :: [String]

Documentation

data CoalesceArguments Source #

Arguments need to simulate phylogenetic trees using the coalescent process.

Constructors

CoalesceArguments
Fields argsNTrees :: Int Number of simulated trees. argsNLeaves :: Int Number of leaves per tree. argsRho :: Maybe Double Perform random sub-sampling with given sampling rate. argsSumStat :: Bool Only print summary statistics? argsSeed :: Seed Seed of NRG, random if `Nothing`.

Instances

Eq CoalesceArguments Source #
Instance details Defined in TLynx.Coalesce.Options Methods (==) :: CoalesceArguments -> CoalesceArguments -> Bool # (/=) :: CoalesceArguments -> CoalesceArguments -> Bool #
Show CoalesceArguments Source #
Instance details Defined in TLynx.Coalesce.Options Methods showsPrec :: Int -> CoalesceArguments -> ShowS # show :: CoalesceArguments -> String # showList :: [CoalesceArguments] -> ShowS #
Generic CoalesceArguments Source #
Instance details Defined in TLynx.Coalesce.Options Associated Types type Rep CoalesceArguments :: Type -> Type # Methods from :: CoalesceArguments -> Rep CoalesceArguments x # to :: Rep CoalesceArguments x -> CoalesceArguments #
ToJSON CoalesceArguments Source #
Instance details Defined in TLynx.Coalesce.Options Methods toJSON :: CoalesceArguments -> Value # toEncoding :: CoalesceArguments -> Encoding # toJSONList :: [CoalesceArguments] -> Value # toEncodingList :: [CoalesceArguments] -> Encoding #
FromJSON CoalesceArguments Source #
Instance details Defined in TLynx.Coalesce.Options Methods parseJSON :: Value -> Parser CoalesceArguments # parseJSONList :: Value -> Parser [CoalesceArguments] #
Reproducible CoalesceArguments Source #
Instance details Defined in TLynx.Coalesce.Options Methods inFiles :: CoalesceArguments -> [FilePath] # outSuffixes :: CoalesceArguments -> [String] # getSeed :: CoalesceArguments -> Maybe Seed # setSeed :: CoalesceArguments -> Vector Word32 -> CoalesceArguments # parser :: Parser CoalesceArguments # cmdName :: String # cmdDsc :: [String] # cmdFtr :: [String] #
type Rep CoalesceArguments Source #
Instance details Defined in TLynx.Coalesce.Options type Rep CoalesceArguments = D1 (MetaData "CoalesceArguments" "TLynx.Coalesce.Options" "tlynx-0.3.2-I41YUX7QtfkBLX5ZeepvaY" False) (C1 (MetaCons "CoalesceArguments" PrefixI True) ((S1 (MetaSel (Just "argsNTrees") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "argsNLeaves") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :: (S1 (MetaSel (Just "argsRho") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Double)) :: (S1 (MetaSel (Just "argsSumStat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "argsSeed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Seed)))))

coalesceArguments :: Parser CoalesceArguments Source #

Command line parser.

reportCoalesceArguments :: CoalesceArguments -> String Source #

Print useful information about the provided arguments.

coalesceFooter :: [String] Source #

And a footer.