testParameterOptimality: Function to return the optimality of a parameter vector for a...

Description Usage Arguments Value

View source: R/testParameterOptimality.R

Description

Function to return the optimality of a parameter vector for a breeding scheme given a simulation environment

Usage

1
2
testParameterOptimality(sEnv = NULL, schemeFileName, parmList,
  objectiveFunc, budget = 1000)

Arguments

sEnv

the environment that BSL functions operate in. This environment should be fresh from defineSpecies, defineVariances, and defineCosts. If NULL, the default simEnv is attempted

schemeFileName

source file that holds the script of the breeding scheme. The scheme should return a value to be maximized in a variable called objective. If you want to use a non-default simulation environment, you need to plan for that in the schemeFile by giving sEnv as the first parameter in all of the BSL functions

parmList

(preferably) named list with values of parameters characterizing the breeding scheme

objectiveFunc

a function that can be applied to a BSL simulation environment to return a value showing the realized performance of the breeding scheme

budget

the maximum budget that is allowed for the breeding scheme

Value

Two-object list: objective is the objective function value of the breeding scheme given the simulation environment and the parameter vector and totalCost is the budget used by the breeding scheme. If the parameter vector causes the scheme to exceed the given budget, objective=NA


BreedingSchemeLanguage documentation built on May 2, 2019, 10:17 a.m.