Learn R Programming

foreSIGHT (version 0.9.81)

devScenarioClean: devScenarioClean

Description

Takes the IO="dev" output of scenariogenerator and repacks it into the IO="verbose" style.

Usage

devScenarioClean(obs=NULL,
                 optimArgs=NULL,
                 attPerturb=NULL,
                 attHold=NULL,
                 attPenalty=NULL,
                 modelTag=NULL,
                 modelInfoMod=list(),
                 exSpArgs=NULL, 
                 simDirectory=NULL,
                 nSeed=NULL,
                 nRep=NULL,
                 repack=FALSE
                 )

Arguments

obs

A dataframe of observed climate data in the form Year Month Day P Temp.

optimArgs

A list controlling the search algorithm with the following components:

pcrossover

a value of probability of crossover. Defaults to 0.8.

pmutation

a value of probability of mutation. Defaults to 0.1

maxiter

a value of the maximum number of generations. Defaults to 50

maxFitness

a value of the stopping criteria. Defaults to 0.001

popSize

a value of the population size. Defaults to 100

run

a value of an alternative stopping criteria - consecutive runs without improvement in fitness. Defaults to 0.001

seed

a value of the random seed. Defaults to 1234.

parallel

specifies if parallel computing should be used. Defaults to False. Can be set to the number of desired cores, or TRUE, where it will detect the number of available cores and run.

keepBest

specifies if the optimisation should keep the best solution in each generation. Defaults to TRUE.

lambda.mult

A multiplier used during the optimisation for primary attributes. Defaults to zero.

attPerturb

A character vector of climate attributes to hold at a target. A list of all supported attributes can be found under shown under details below.

attHold

A character vector of climate attributes to hold at a target. A list of all supported attributes can be found under shown under details below.

attPenalty

A character vector of climate attributes to place specific focus on during targeting via the use of a penalty function during the optimisation process.

modelTag

A character vector of which stochastic models to use to create each climate variable.Supported tags are shown under details below.

modelInfoMod

A list containing information for modifying stochastic model bounds and defining fixed parameters.

exSpArgs

a list to control the exposure space creation with the following components:

type

a string that specifies the type of sampling. Defaults to regular spacing.

samp

a vector indicating the number of targets for each attribute in attSel.

bounds

a list containing elements for attributes listed in attSel, where each attribute has bounds specified. This should be a single value for a stationary target, and a vector of min and max change for primary attributes. Works with samp to create number of step sizes. Defaults with samp to only reproduce historical weather.

simDirectory

A string used to label the output directory.

nSeed

A scalar used to specify the number of seeds (in this case replicates) for the stochastic generation of time series.

nRep

A scalar that indicates the total number of files (i.e. no. targets x n seeds)

repack

If TRUE writes .csv files of all collates scenarios.

Details

Repackages output from IOmode="dev" runs of sceanariogenerator function.