make_ShinyCGNM_parameterInfo: make_ShinyCGNM_parameterInfo

In CGNM: Cluster Gauss-Newton Method

make_ShinyCGNM_parameterInfo

Description

A helper function to write out the csv file that can be read in as the parameter info file in shinyCGNM

Usage

make_ShinyCGNM_parameterInfo(
  ParameterName,
  Initial_lower_range,
  Initial_upper_range,
  Lower_bound = 0,
  Upper_bound = NA,
  VaryByID = 0,
  MO_weight = 0,
  MO_value = NA,
  Unit = NA,
  fileName = NA
)

Arguments

ParameterName	(required input) string or vector Name of the parameters. Must cover every parameter used in the ODE_text, every free symbol used in the dose data's dose, start.time, and rate columns, and every free symbol used in the initial condition data's value column.
Initial_lower_range	(required input) number or numeric vector lower range of the initial guess used in Cluster_Gauss_Newton_method's initial_lowerRange.
Initial_upper_range	(required input) number or numeric vector upper range of the initial guess used in Cluster_Gauss_Newton_method's initial_upperRange.
Lower_bound	(default: 0) number, NA, or numeric vector used in Cluster_Gauss_Newton_method's lowerBound. Set NA if there is no lower bound.
Upper_bound	(default: NA) number, NA, or numeric vector used in Cluster_Gauss_Newton_method's upperBound. Set NA if there is no upper bound.
VaryByID	(default: 0) 0, 3, or another positive integer, can be a vector 0: the parameter is shared across all IDs. 3: the parameter varies by the first 3 characters of ID (e.g., to represent an occasion/period). Any other nonzero value: the parameter varies by the full ID.
MO_weight	(default: 0) number or numeric vector used in Cluster_Gauss_Newton_method's MO_weights for the middle-out method. Set 0 if the parameter is not used in a middle-out constraint.
MO_value	(default: NA) number, NA, or numeric vector used in Cluster_Gauss_Newton_method's MO_values. Required (non-NA) when the corresponding MO_weight is not 0.
Unit	(default: NA) NA, string, or string vector unit of the parameter, only used for documentation purposes in the generated script.
fileName	(default: NA) NA or string

Value

data.frame if fileName is NA Null if fileName is not NA but instead write out the csv file

Examples

make_ShinyCGNM_parameterInfo(
ParameterName=c("ka","CL","V1"),
Initial_lower_range=c(0.01,0.01,0.01),
Initial_upper_range=c(100,100,100)
)

CGNM documentation built on Sept. 13, 2026, 9:06 a.m.