adjust description of Q power (#632)

nmfs-ost · Oct 30, 2024 · bbea7f0 · bbea7f0
1 parent 185401a
commit bbea7f0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/SS_expval.tpl b/SS_expval.tpl
@@ -420,7 +420,7 @@ FUNCTION void Get_expected_values(const int y, const int t);
                 }
 
                 // Q transformations and offsets
-                // option 5:  add offset
+                // option 5:  add offset, useful when survey units are deviations
                 // option 3:  use power function
                 // option 6:  add offset, then use power function
                 if (Q_setup(f, 1) == 5 || Q_setup(f, 1) == 6 ) //  add offset

diff --git a/SS_write_ssnew.tpl b/SS_write_ssnew.tpl
@@ -2396,9 +2396,11 @@ FUNCTION void write_nucontrol()
     }
   NP += N_Fparm;
   report4 << "#" << endl;
-  report4 << "#_Q_setup for fleets with cpue or survey data" << endl;
+  report4 << "#_Q_setup for fleets with cpue or survey or deviation data" << endl;
   report4 << "#_1:  fleet number" << endl;
   report4 << "#_2:  link type: 1=simple q; 2=mirror; 3=power (+1 parm); 4=mirror with scale (+1p); 5=offset (+1p); 6=offset & power (+2p)" << endl;
+  report4 << "#_     where power is applied as y = q * x ^ (1 + power); so a power value of 0 has null effect" << endl;
+  report4 << "#_     and with the offset included it is y = q * (x + offset) ^ (1 + power)" << endl;
   report4 << "#_3:  extra input for link, i.e. mirror fleet# or dev index number" << endl;
   report4 << "#_4:  0/1 to select extra sd parameter" << endl;
   report4 << "#_5:  0/1 for biasadj or not" << endl;