Add ntrt option to frem

UUPharmacometrics · Feb 8, 2024 · f0b11b4 · f0b11b4
1 parent 4ed0bdb
commit f0b11b4
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 6 deletions.
diff --git a/bin/frem b/bin/frem
@@ -35,6 +35,7 @@ my %optional_options = (
     'categorical:s' => undef,
     'deriv2_nocommon_maxeta:i' => undef,
     "mceta:i"=>'',
+    'ntrt:s' => undef,
     'log:s' => undef,
     'rse:f' => undef,
     'run_sir!' => undef,
@@ -221,6 +222,13 @@ $help_text{-mu} = <<'EOF';
     so that any skipped omegas come first.
 EOF
 
+$help_text{-ntrt} = <<'EOF';
+    -ntrt
+
+    Column name for number of individuals in aggregate data. Default not used.
+EOF
+
+
 $help_text{-rescale} = <<'EOF';
     -rescale
 
@@ -327,6 +335,7 @@ my $frem = tool::frem->new(
     bipp => $options{'bipp'},
     force_posdef_covmatrix => $options{'force_posdef_covmatrix'},
     force_posdef_samples => $options{'force_posdef_samples'},
+    ntrt => $options{'ntrt'},
 );
 
 $frem->print_options(

diff --git a/lib/tool/frem.pm b/lib/tool/frem.pm
@@ -77,6 +77,7 @@ has 'tool_options' => ( is => 'rw', isa => 'HashRef' );     # tool options hash
 has 'bipp' => ( is => 'rw', isa => 'Bool', default => 0 );
 has 'force_posdef_covmatrix' => ( is => 'rw', isa => 'Bool', default => 0 );
 has 'force_posdef_samples' => ( is => 'rw', isa => 'Int', default => 500 );
+has 'ntrt' => ( is => 'rw', isa => 'Str' );
 
 
 has '_intermediate_models_path' => ( is => 'rw', isa => 'Str' );
@@ -1444,6 +1445,7 @@ sub get_pred_error_pk_code
         likelihood => { isa => 'Bool', default => 0},
         loglikelihood => { isa => 'Bool', default => 0},
         have_fflag  => { isa => 'Bool', default => 0},
+        ntrt => { isa => 'Maybe[Str]' },
     );
     my $covariates = $parm{'covariates'};
     my $maxeta = $parm{'maxeta'};
@@ -1460,6 +1462,7 @@ sub get_pred_error_pk_code
     my $likelihood = $parm{'likelihood'};
     my $loglikelihood = $parm{'loglikelihood'};
     my $have_fflag = $parm{'have_fflag'};
+    my $ntrt = $parm{'ntrt'};
 
     my @pkcode;
     my @pred_error_code = (';;;FREM CODE BEGIN COMPACT',';;;DO NOT MODIFY');
@@ -1482,6 +1485,12 @@ sub get_pred_error_pk_code
     my @rescale_strings;
     my @rescale_factors;
 
+    if (defined $ntrt) {
+        $ntrt = '/SQRT(' . $ntrt . ')';
+    } else {
+        $ntrt = '';
+    }
+
     for (my $j = 0; $j < scalar(@{$covariates}); $j++) {
         my $label = 'BSV_' . $covariates->[$j];
         my $etanum = ($maxeta + 1 + $j);
@@ -1529,11 +1538,11 @@ sub get_pred_error_pk_code
         for (my $j = 0; $j < scalar(@{$covariates}); $j++) {
             my $etanum = ($maxeta + 1 + $j);
             if ($rescale) {
-                push(@mucode, $indent.'MU_'.$etanum.' = '.$theta_strings[$j].'/SDC'.$etanum);
-                push(@mucode, $indent.'COV'.$etanum.' = (MU_'.$etanum.' + '.$eta_strings[$j]->[0].')*SDC'.$etanum);
+                push(@mucode, $indent . 'MU_' . $etanum . ' = ' . $theta_strings[$j] . '/SDC' . $etanum);
+                push(@mucode, $indent . 'COV' . $etanum . ' = (MU_' . $etanum . ' + ' . $eta_strings[$j]->[0] . $ntrt . ')*SDC' . $etanum);
             } else {
-                push(@mucode,$indent.'MU_'.$etanum.' = '.$theta_strings[$j]);
-                push(@mucode,$indent.'COV'.$etanum.' = MU_'.$etanum.' + '.$eta_strings[$j]->[0]);
+                push(@mucode, $indent . 'MU_' . $etanum . ' = ' . $theta_strings[$j]);
+                push(@mucode, $indent . 'COV' . $etanum . ' = MU_' . $etanum . ' + ' . $eta_strings[$j]->[0] . $ntrt);
             }
         }
         push(@code,@mucode);
@@ -1552,7 +1561,7 @@ sub get_pred_error_pk_code
                 $ipred = 'COV'.($maxeta+1+$i);
             }else{
                 my $rescale_expr = $rescale ? '*'.$rescale_strings[$i] : '';
-                $ipred = $theta_strings[$i].' + '.$eta_strings[$i]->[$j].$rescale_expr;
+                $ipred = $theta_strings[$i] . ' + ' . $eta_strings[$i]->[$j] . $rescale_expr . $ntrt;
             }
             if ($N_parameter_blocks > 1){
                 $comment .= ' occasion '.($j+1);
@@ -1625,6 +1634,7 @@ sub prepare_model2
         likelihood => $self->_likelihood,
         loglikelihood => $self->_loglikelihood,
         have_fflag => $self->_have_fflag,
+        ntrt => $self->ntrt,
     );
 
     cleanup_outdated_model(modelname => File::Spec->catfile($self->_intermediate_models_path, $name_model),

diff --git a/pharmpy b/pharmpy
+2 −2		docs/amd.rst
+1 −1		docs/covsearch.rst
+3 −3		docs/iivsearch.rst
+1 −1		docs/requirements.txt
+5 −5		lint-requirements.txt
+3 −3		pretest-requirements.txt
+20 −20		requirements.txt
+12 −12		src/pharmpy/model/estimation.py
+4 −1		src/pharmpy/model/external/nonmem/model.py
+2 −2		src/pharmpy/model/external/nonmem/update.py
+0 −11		src/pharmpy/model/model.py
+1 −1		src/pharmpy/modeling/estimation_steps.py
+4 −4		src/pharmpy/modeling/results.py
+3 −3		src/pharmpy/tools/amd/run.py
+2 −2		src/pharmpy/tools/estmethod/tool.py
+5 −1		src/pharmpy/tools/frem/results.py
+1 −1		src/pharmpy/tools/modelsearch/algorithms.py
+1 −1		test-requirements.txt
+1 −2		tests/integration/test_modelsearch.py
+1 −6		tests/integration/test_resume.py
+1 −1		tests/modeling/test_estimation_steps.py
+2 −2		tests/nonmem/test_nonmem_model.py