ParamHelpers: Helpers for Parameters in Black-Box Optimization, Tuning and Machine Learning
Version 1.10

Functions for parameter descriptions and operations in black-box optimization, tuning and machine learning. Parameters can be described (type, constraints, defaults, etc.), combined to parameter sets and can in general be programmed on. A useful OptPath object (archive) to log function evaluations is also provided.

Browse man pages Browse package API and functions Browse package files

AuthorBernd Bischl [aut, cre], Michel Lang [aut], Jakob Bossek [aut], Daniel Horn [aut], Karin Schork [ctb], Jakob Richter [aut], Pascal Kerschke [aut]
Date of publication2017-01-05 19:24:24
MaintainerBernd Bischl <bernd_bischl@gmx.net>
LicenseBSD_2_clause + file LICENSE
Version1.10
URL https://github.com/berndbischl/ParamHelpers
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("ParamHelpers")

Man pages

addOptPathEl: Add a new element to an optimization path.
as.data.frame.OptPathDF: Convert optimization path to data.frame.
checkParamSet: Sanity check expressions of a parameter set.
convertParamSetToIrace: Converts a ParamSet object to a parameter object of the irace...
dfRowsToList: Convert a data.frame row to list of parameter-value-lists.
discreteNameToValue: Convert encoding name(s) to discrete value(s).
discreteValueToName: Convert discrete value(s) to encoding name(s).
dropParams: Drop Params from ParamSet by ids.
evaluateParamExpressions: Evaluates all expressions within a parameter.
filterParams: Get parameter subset of only certain parameters.
generateDesign: Generates a statistical design for a parameter set.
generateDesignOfDefaults: Generates a design with the defaults of a parameter set.
generateGridDesign: Generates a grid design for a parameter set.
generateRandomDesign: Generates a random design for a parameter set.
getDefaults: Return defaults of parameters in parameter set.
getLower: Get lower / upper bounds and allowed discrete values for...
getOptPathBestIndex: Get index of the best element from optimization path.
getOptPathCol: Get column from the optimization path.
getOptPathCols: Get columns from the optimization path.
getOptPathDOB: Get date-of-birth vector from the optimization path.
getOptPathEl: Get an element from the optimization path.
getOptPathEOL: Get end-of-life vector from the optimization path.
getOptPathErrorMessages: Get error-message vector from the optimization path.
getOptPathExecTimes: Get exec-time vector from the optimization path.
getOptPathLength: Get the length of the optimization path.
getOptPathParetoFront: Get indices of pareto front of optimization path.
getOptPathX: Get data.frame of input points (X-space) referring to the...
getOptPathY: Get y-vector or y-matrix from the optimization path.
getParamIds: Return ids of parameters in parameter set.
getParamLengths: Return lengths of single parameters or parameters in...
getParamNr: Return number of parameters in set.
getParamSet: Get parameter set.
getParamTypeCounts: Returns information on the number of parameters of a each...
getParamTypes: Returns type information for a parameter set.
getRequirements: Return all require-expressions of a param set.
getTypeStrings: Get parameter type-strings.
hasExpression: Check if parameter values contain expressions.
hasFiniteBoxConstraints: Checks if a parameter or each parameter of a parameter set...
hasForbidden: Check parameter set for forbidden region.
hasRequires: Check parameter / parameter set for requirements /...
hasTrafo: Check parameter / parameter set for trafos.
hasType: Check whether parameter set contains a certain type.
isEmpty: Check whether parameter set is empty.
isFeasible: Check if parameter value is valid.
isForbidden: Check whether parameter setting lies in forbidden region of...
isRequiresOk: Check if parameter requirements are met.
isSpecialValue: Is a given value in the list of special values for a param?
isType: Check parameter / parameter set contain ONLY a certain type.
isTypeString: Check if type string is of certain type.
isVector: Check parameter / parameter set for vector params.
LearnerParam: Create a description object for a parameter of a machine...
makeParamSet: Construct a parameter set.
OptPath: Create optimization path.
Param: Create a description object for a parameter.
paramValueToString: Convert a value to a string.
plotEAF: Plots attainment functions for data stored in multiple...
plotOptPath: Plot method for optimization paths.
plotYTraces: Plots Y traces of multiple optimization paths
removeMissingValues: Removes all scalar NAs from a parameter setting list.
renderOptPathPlot: Function for plotting optimization paths.
renderYTraces: Plots Y traces of multiple optimization paths
repairPoint: Repairs values of numeric and integer parameters out side of...
sampleValue: Sample a random value from a parameter or a parameter set...
sampleValues: Sample n random values from a parameter or a parameter set...
setOptPathElDOB: Set the dates of birth of parameter values, in-place.
setOptPathElEOL: Set the end of life dates of parameter values, in-place.
setValueCNames: Set components names for vector names
trafoOptPath: Transform optimization path.
trafoValue: Transform a value.
updateParVals: Insert par.vals to old ones with meeting requirements

Functions

LearnerParam Man page
OptPath Man page
OptPathDF Man page
Param Man page
ParamSet Man page
addOptPathEl Man page Source code
addOptPathEl.OptPathDF Source code
as.data.frame.OptPathDF Man page Source code
c.ParamSet Source code
checkExpressionFeasibility Source code
checkLength Source code
checkParamSet Man page Source code
checkValuesForDiscreteParam Source code
constraintsOkParam Source code
convertExpressionToCall Source code
convertParamSetToIrace Man page Source code
convertTypesToCInts Source code
dfRowToList Man page Source code
dfRowsToList Man page Source code
discreteNameToValue Man page Source code
discreteValueToName Man page Source code
doBasicGenDesignChecks Source code
dropParams Man page Source code
evaluateParamExpressions Man page Source code
evaluateParamExpressions.Param Source code
evaluateParamExpressions.ParamSet Source code
evaluateParamExpressions.list Source code
filterParams Man page Source code
filterParamsDiscrete Man page Source code
filterParamsNumeric Man page Source code
fixDesignFactors Source code
fixDesignVarTypes Source code
generateDesign Man page Source code
generateDesignOfDefaults Man page Source code
generateGridDesign Man page Source code
generateRandomDesign Man page Source code
getAndSubsetPlotData Source code
getBounds Source code
getBounds.Param Source code
getBounds.ParamSet Source code
getBounds.list Source code
getDefaults Man page Source code
getDefaults.Param Source code
getDefaults.ParamSet Source code
getDefaults.list Source code
getLower Man page Source code
getMaxPlotWidth Source code
getOptPathBestIndex Man page Source code
getOptPathCol Man page Source code
getOptPathCol.OptPathDF Source code
getOptPathColAtTime Source code
getOptPathColAtTimes Source code
getOptPathCols Man page Source code
getOptPathCols.OptPathDF Source code
getOptPathDOB Man page Source code
getOptPathDOB.OptPathDF Source code
getOptPathDobAndEolIndex Source code
getOptPathEOL Man page Source code
getOptPathEOL.OptPathDF Source code
getOptPathEl Man page Source code
getOptPathEl.OptPathDF Source code
getOptPathErrorMessages Man page Source code
getOptPathErrorMessages.OptPathDF Source code
getOptPathExecTimes Man page Source code
getOptPathExecTimes.OptPathDF Source code
getOptPathLength Man page Source code
getOptPathLength.OptPathDF Source code
getOptPathLims Source code
getOptPathParetoFront Man page Source code
getOptPathX Man page Source code
getOptPathX.OptPathDF Source code
getOptPathY Man page Source code
getOptPathY.OptPathDF Source code
getParPrintData Source code
getParSetPrintData Source code
getParamIds Man page Source code
getParamIds.Param Source code
getParamIds.ParamSet Source code
getParamLengths Man page Source code
getParamLengths.Param Source code
getParamLengths.ParamSet Source code
getParamNA Source code
getParamNr Man page Source code
getParamSet Man page Source code
getParamSetValues Source code
getParamTypeCounts Man page Source code
getParamTypes Man page Source code
getRequiredParamNames Source code
getRequiredParamNames.Param Source code
getRequiredParamNames.ParamSet Source code
getRequirements Man page Source code
getTypeStrings Man page
getTypeStringsAll Man page Source code
getTypeStringsCharacter Man page Source code
getTypeStringsDiscrete Man page Source code
getTypeStringsInteger Man page Source code
getTypeStringsLogical Man page Source code
getTypeStringsNumeric Man page Source code
getTypeStringsNumericStrict Man page Source code
getUpper Man page Source code
getValues Man page Source code
getValues.Param Source code
getValues.ParamSet Source code
getValues.list Source code
hasAllParamsOfTypes Source code
hasCharacter Man page Source code
hasDiscrete Man page Source code
hasExpression Man page Source code
hasExpression.LearnerParam Source code
hasExpression.LearnerParamSet Source code
hasExpression.Param Source code
hasExpression.ParamSet Source code
hasExpression.list Source code
hasFiniteBoxConstraints Man page Source code
hasFiniteBoxConstraints.Param Source code
hasFiniteBoxConstraints.ParamSet Source code
hasForbidden Man page Source code
hasInteger Man page Source code
hasLogical Man page Source code
hasNumeric Man page Source code
hasRequires Man page Source code
hasRequires.Param Source code
hasRequires.ParamSet Source code
hasSomeParamsOfTypes Source code
hasTrafo Man page Source code
hasTrafo.Param Source code
hasTrafo.ParamSet Source code
hasType Man page
imputeMissingValues Source code
inBoundsOrExpr Source code
isCharacter Man page Source code
isCharacter.Param Source code
isCharacter.ParamSet Source code
isCharacterTypeString Man page Source code
isDiscrete Man page Source code
isDiscrete.Param Source code
isDiscrete.ParamSet Source code
isDiscreteTypeString Man page Source code
isEmpty Man page Source code
isEmpty.ParamSet Source code
isFeasible Man page Source code
isFeasible.LearnerParam Source code
isFeasible.Param Source code
isFeasible.ParamSet Source code
isForbidden Man page Source code
isInteger Man page Source code
isInteger.Param Source code
isInteger.ParamSet Source code
isIntegerTypeString Man page Source code
isLogical Man page Source code
isLogical.Param Source code
isLogical.ParamSet Source code
isLogicalTypeString Man page Source code
isNumeric Man page Source code
isNumeric.Param Source code
isNumeric.ParamSet Source code
isNumericTypeString Man page Source code
isRequiresOk Man page Source code
isSpecialValue Man page Source code
isType Man page
isTypeString Man page
isVector Man page Source code
isVector.Param Source code
isVector.ParamSet Source code
isVectorTypeString Man page Source code
listToDfOneRow Source code
makeCharacterParam Man page Source code
makeCharacterVectorParam Man page Source code
makeDiscreteLearnerParam Man page Source code
makeDiscreteParam Man page Source code
makeDiscreteVectorLearnerParam Man page Source code
makeDiscreteVectorParam Man page Source code
makeFunctionLearnerParam Man page Source code
makeFunctionParam Man page Source code
makeIntegerLearnerParam Man page Source code
makeIntegerParam Man page Source code
makeIntegerVectorLearnerParam Man page Source code
makeIntegerVectorParam Man page Source code
makeLearnerParam Source code
makeLogicalLearnerParam Man page Source code
makeLogicalParam Man page Source code
makeLogicalVectorLearnerParam Man page Source code
makeLogicalVectorParam Man page Source code
makeNumericLearnerParam Man page Source code
makeNumericParam Man page Source code
makeNumericParamSet Man page Source code
makeNumericVectorLearnerParam Man page Source code
makeNumericVectorParam Man page Source code
makeOptPath Source code
makeOptPathDF Man page Source code
makeParam Source code
makeParamSet Man page Source code
makeUntypedLearnerParam Man page Source code
makeUntypedParam Man page Source code
multiVariablesOverTime Source code
oneVariableOverTime Source code
paramValueToString Man page Source code
paramValueToString.Param Source code
paramValueToString.ParamSet Source code
plot1DDisc Source code
plot1DNum Source code
plot2D Source code
plotEAF Man page Source code
plotMultiD Source code
plotOptPath Man page Source code
plotYTraces Man page Source code
print.LearnerParam Source code
print.OptPath Source code
print.Param Source code
print.ParamSet Source code
removeDotEntries Source code
removeMissingValues Man page Source code
renderOptPathPlot Man page Source code
renderYTraces Man page Source code
repairPoint Man page Source code
requiresOk Source code
sampleValue Man page Source code
sampleValue.Param Source code
sampleValue.ParamSet Source code
sampleValues Man page Source code
setOptPathElDOB Man page Source code
setOptPathElEOL Man page Source code
setValueCNames Man page Source code
setValueCNames.Param Source code
setValueCNames.ParamSet Source code
stopIfFunOrUntypedParams Source code
stopIfLearnerParams Source code
toAlignedGTable Source code
toGTable Source code
trafoOptPath Man page Source code
trafoValue Man page Source code
updateParVals Man page Source code
valueToString Source code

Files

tests
tests/run-all.R
tests/testthat
tests/testthat/test_hasExpression.R
tests/testthat/Rplots.pdf
tests/testthat/test_forbidden.R
tests/testthat/test_updateParVals.R
tests/testthat/test_generateDesignOfDefaults.R
tests/testthat/test_OptPath.R
tests/testthat/test_convertDiscrete.R
tests/testthat/test_plotEAF.R
tests/testthat/test_LearnerParam.R
tests/testthat/test_sample.R
tests/testthat/test_hasIsType.R
tests/testthat/test_getRequiredParamNames.R
tests/testthat/test_isSpecialValue.R
tests/testthat/test_isFeasible.R
tests/testthat/test_Param.R
tests/testthat/test_evaluateParamExpressions.R
tests/testthat/test_renderOptPathPlot.R
tests/testthat/test_filterParams.R
tests/testthat/test_generateGridDesign.R
tests/testthat/test_generateDesign.R
tests/testthat/test_paramValueToString.R
tests/testthat/test_dropParams.R
tests/testthat/test_getParamTypes.R
tests/testthat/test_plotYTrace.R
tests/testthat/helper_zzz.R
tests/testthat/test_convertParamSetToIrace.R
tests/testthat/test_trafo.R
tests/testthat/test_generateRandomDesign.R
tests/testthat/test_getRequirements.R
tests/testthat/test_getParamTypeCounts.R
tests/testthat/test_getParamNr.R
tests/testthat/test_dfRowToList.R
tests/testthat/test_repairPoint.R
tests/testthat/test_hasFiniteBoxConstraints.R
tests/testthat/test_getDefaults.R
tests/testthat/test_hasRequires.R
tests/testthat/test_ParamSet.R
tests/testthat/test_cnames.R
tests/testthat/test_isVector.R
src
src/c_generateDesign.c
src/c_dfRowsToList.c
NAMESPACE
NEWS
R
R/OptPathDF_setter.R
R/ParamSet.R
R/getRequiredParamNames.R
R/OptPathDF_getter.R
R/convertTypesToCInts.R
R/utils.R
R/getParamNr.R
R/dropParams.R
R/OptPath_getter.R
R/OptPath_plotYTraces.R
R/LearnerParam.R
R/isTypeString.R
R/checkParamSet.R
R/isRequiresOk.R
R/convertDiscrete.R
R/listToDfOneRow.R
R/sample.R
R/makeLearnerParamFuns.R
R/generateDesign.R
R/hasRequires.R
R/getDefaults.R
R/hasTrafo.R
R/removeMissingValues.R
R/getParamTypeCounts.R
R/OptPath_plotEAF.R
R/isSpecialValue.R
R/getRequirements.R
R/convertParamSetToIrace.R
R/hasForbidden.R
R/OptPath_plotter.R
R/OptPathDF.R
R/dfRowsToList.R
R/renderOptPathPlot.R
R/generateGridDesign.R
R/hasExpression.R
R/getBounds.R
R/renderOptPathPlot_workers.R
R/aParam.R
R/trafo.R
R/getTypeStrings.R
R/isType.R
R/getParamIds.R
R/generateDesignOfDefaults.R
R/OptPathDF_as_data_frame.R
R/repairPoint.R
R/filterParams.R
R/generateRandomDesign.R
R/hasType.R
R/evaluateParamExpressions.R
R/makeParamFuns.R
R/updateParVals.R
R/OptPath.R
R/hasFiniteBoxConstraints.R
R/isVector.R
R/setValueCNames.R
R/getParamSet.R
R/getParamTypes.R
R/paramValueToString.R
R/OptPath_setter.R
R/getParamLengths.R
R/isFeasible.R
R/renderOptPathPlot_helpers.R
R/zzz.R
R/isForbidden.R
MD5
DESCRIPTION
man
man/dropParams.Rd
man/getOptPathCol.Rd
man/isFeasible.Rd
man/getOptPathX.Rd
man/renderOptPathPlot.Rd
man/getOptPathErrorMessages.Rd
man/hasForbidden.Rd
man/setOptPathElDOB.Rd
man/paramValueToString.Rd
man/renderYTraces.Rd
man/sampleValue.Rd
man/getRequirements.Rd
man/evaluateParamExpressions.Rd
man/isVector.Rd
man/plotEAF.Rd
man/getOptPathLength.Rd
man/hasTrafo.Rd
man/getOptPathY.Rd
man/dfRowsToList.Rd
man/getOptPathEOL.Rd
man/getParamNr.Rd
man/getParamSet.Rd
man/getParamLengths.Rd
man/getParamIds.Rd
man/plotYTraces.Rd
man/isForbidden.Rd
man/getOptPathDOB.Rd
man/removeMissingValues.Rd
man/as.data.frame.OptPathDF.Rd
man/Param.Rd
man/trafoValue.Rd
man/generateDesignOfDefaults.Rd
man/LearnerParam.Rd
man/setValueCNames.Rd
man/filterParams.Rd
man/getOptPathExecTimes.Rd
man/getOptPathBestIndex.Rd
man/getOptPathEl.Rd
man/convertParamSetToIrace.Rd
man/discreteNameToValue.Rd
man/trafoOptPath.Rd
man/generateRandomDesign.Rd
man/isType.Rd
man/getTypeStrings.Rd
man/setOptPathElEOL.Rd
man/getOptPathParetoFront.Rd
man/discreteValueToName.Rd
man/hasRequires.Rd
man/getOptPathCols.Rd
man/updateParVals.Rd
man/isTypeString.Rd
man/isEmpty.Rd
man/hasType.Rd
man/repairPoint.Rd
man/OptPath.Rd
man/addOptPathEl.Rd
man/isRequiresOk.Rd
man/isSpecialValue.Rd
man/sampleValues.Rd
man/getLower.Rd
man/hasExpression.Rd
man/makeParamSet.Rd
man/getParamTypes.Rd
man/generateDesign.Rd
man/getDefaults.Rd
man/getParamTypeCounts.Rd
man/plotOptPath.Rd
man/hasFiniteBoxConstraints.Rd
man/checkParamSet.Rd
man/generateGridDesign.Rd
LICENSE
ParamHelpers documentation built on May 20, 2017, 2:50 a.m.