PCMGenerateParameterizations: Generate possible parameterizations for a given type of model

In venelin/PCMBase: Simulation and Likelihood Calculation of Phylogenetic Comparative Models

Generate possible parameterizations for a given type of model

Description

A parameterization of a PCM of given type, e.g. OU, is a PCM-class inheriting from this type, which imposes some restrictions or transformations of the parameters in the base-type. This function generates the S3 methods responsible for creating such parameterizations, in particular it generates the definition of the methods for the two S3 generics 'PCMParentClasses' and 'PCMSpecify' for al parameterizations specified in the 'tableParameterizations' argument.

Usage

PCMGenerateParameterizations(
  model,
  listParameterizations = PCMListParameterizations(model),
  tableParameterizations = PCMTableParameterizations(model, listParameterizations),
  env = .GlobalEnv,
  useModelClassNameForFirstRow = FALSE,
  sourceFile = NULL
)

Arguments

model	a PCM object.
listParameterizations	a list or a sublist returned by 'PCMListParameterizations'. Default: 'PCMListParameterizations(model)'.
tableParameterizations	a data.table containing the parameterizations to generate. By default this is generated from 'listParameterizations' using a call 'PCMTableParameterizations(model, listParameterizations)'. If specified by the user, this parameter takes precedence over 'listParameterizations' and 'listParameterizations' is not used.
env	an environment where the method definitions will be stored. Default: 'env = .GlobalEnv'.
useModelClassNameForFirstRow	A logical specifying if the S3 class name of 'model' should be used as a S3 class for the model defined in the first row of 'tableParameterizations'. Default: FALSE.
sourceFile	NULL or a character string indicating a .R filename, to which the automatically generated code will be saved. If NULL (the default), the generated source code is evaluated and the S3 methods are defined in the global environment. Default: NULL.

Value

This function does not return a value. It only has a side effect by defining S3 methods in 'env'.

venelin/PCMBase documentation built on March 14, 2024, 8:24 p.m.