html/cdd_docs.php

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4   <title>PsN :: Documentation :: cdd</title>
   5 <!--Adobe(R) LiveMotion(TM) 1.0 Generated JavaScript. Please do not edit. -->
   6   <script>
   7
   8 <!--
   9
  10 function newImage(arg) {
  11
  12 if (document.images) {
  13
  14 rslt = new Image();
  15
  16 rslt.src = arg;
  17
  18 return rslt;
  19
  20 }
  21
  22 }
  23
  24 ImageArray = new Array;
  25
  26 var preloadFlag = false;
  27
  28 function preloadImages() {
  29
  30 if (document.images) {
  31
  32 ImageArray[ImageArray.length++] = newImage(/* OWNER('object', 'dflt') *//*URL*/'images/indexhome.jpg');
  33 ImageArray[ImageArray.length++] = newImage(/* OWNER('object', 'movr') *//*URL*/'images/indexhomeov.jpg');
  34 ImageArray[ImageArray.length++] = newImage(/* OWNER('object1', 'dflt') *//*URL*/'images/indexdocumentation.jpg');
  35 ImageArray[ImageArray.length++] = newImage(/* OWNER('object1', 'movr') *//*URL*/'images/indexdocumentationov.jpg');
  36 ImageArray[ImageArray.length++] = newImage(/* OWNER('object2', 'dflt') *//*URL*/'images/indexdownload.jpg');
  37 ImageArray[ImageArray.length++] = newImage(/* OWNER('object2', 'movr') *//*URL*/'images/indexdownloadov.jpg');
  38 ImageArray[ImageArray.length++] = newImage(/* OWNER('object3', 'dflt') *//*URL*/'images/indexbuglist.jpg');
  39 ImageArray[ImageArray.length++] = newImage(/* OWNER('object3', 'movr') *//*URL*/'images/indexbuglistov.jpg');
  40 ImageArray[ImageArray.length++] = newImage(/* OWNER('object4', 'dflt') *//*URL*/'images/indexmailing_list.jpg');
  41 ImageArray[ImageArray.length++] = newImage(/* OWNER('object4', 'movr') *//*URL*/'images/indexmailing_listov.jpg');
  42 preloadFlag = true;
  43 }
  44 }
  45 function changeImages() {
  46 if (document.images && (preloadFlag == true)) {
  47 for (var i=0; i<changeImages.arguments.length; i+=2) {
  48 document[changeImages.arguments[i]].src = changeImages.arguments[i+1];
  49 }
  50 }
  51 }
  52 // -->
  53   </script><!-- End generated JavaScript. -->
  54   <meta http-equiv="Content-Type"
  55  content="text/html; charset=ISO-8859-1">
  56   <style type="text/css">
  57 <!--
  58 body,td,th {
  59 font-family: Helvetica, Arial, serif;
  60 font-size: 12px;
  61 color: #000000;
  62 }
  63 body {
  64 margin-left: 6px;
  65 margin-top: 0px;
  66 margin-right: 0px;
  67 margin-bottom: 0px;
  68 background-image: url(gfx/bg.jpg);
  69 }
  70 .style1 {
  71 font-size: 36px;
  72 font-weight: bold;
  73 }
  74 .heading1 {
  75 font-size: 16px;
  76 font-weight: bold;
  77 color: #333399;
  78 margin-left: 40px;
  79 }
  80 a:link {
  81 color: #656D9C;
  82 text-decoration: none;
  83 }
  84 a:visited {
  85 color: #656D9C;
  86 text-decoration: none;
  87 }
  88 a:hover {
  89 color: #AF9D49;
  90 text-decoration: none;
  91 }
  92 a:active {
  93 color: #656D9C;
  94 text-decoration: none;
  95 }
  96 .style2 {font-family: "Courier New", Courier, mono}
  97 -->
  98   </style>
  99   <script language="JavaScript" type="text/JavaScript">
 100 <!--
 101 function MM_reloadPage(init) { //reloads the window if Nav4 resized
 102 if (init==true) with (navigator) {if ((appName=="Netscape")&&(parseInt(appVersion)==4)) {
 103 document.MM_pgW=innerWidth; document.MM_pgH=innerHeight; onresize=MM_reloadPage; }}
 104 else if (innerWidth!=document.MM_pgW || innerHeight!=document.MM_pgH) location.reload();
 105 }
 106 MM_reloadPage(true);
 107 //-->
 108   </script>
 109   <meta content="Pntus Pihlgren" name="author">
 110 </head>
 111 <body onload="preloadImages();"
 112  style="background-color: rgb(255, 255, 255);">
 113 <!-- The table is not formatted nicely because some browsers cannot join images in table cells if there are any hard carriage returns in a TD. -->
 114 <div id="Layer1"
 115  style="position: absolute; left: 335px; top: 42px; width: 388px; height: 43px; z-index: 1; font-size: x-small;">
 116 <div class="style1" align="right">Case-deletion Diagnostics (<span
 117  style="font-family: monospace;">cdd</span>)<br>
 118 </div>
 119 </div>
 120 <div id="Layer2"
 121  style="position: absolute; left: 226px; top: 188px; width: 497px; height: 431px; z-index: 2;">
 122 <div align="justify">
 123 <h3 class="heading1">Synopsis</h3>
 124 <tt>$         cdd [ -h | -? ] [ --help ]<br>
 125 --case_column='column_name|column_number'<br>
 126 [ --bins=integer ]<br>
 127 [ --selection_method=''random'|'consecutive'' ]<br>
 128 [ --abort_on_fail ]<br>
 129 [ --clean ]<br>
 130 [ --compress ]<br>
 131 [ --cpu_time=integer ]<br>
 132 [ --debug=0 ]<br>
 133 [ --debug_package='string' ]<br>
 134 [ --debug_subroutine='string' ]<br>
 135 [ --directory='string' ]<br>
 136 [ --extra_data_file='string' ]<br>
 137 [ --extra_files='string' ]<br>
 138 [ --grid_batch_size=integer ]<br>
 139 [ --missing_data_token='string' ]<br>
 140 [ --nm_directory='string' ]<br>
 141 [ --nm_version='string' ]<br>
 142 [ --outputfile='string' ]<br>
 143 [ --picky ]<br>
 144 [ --remove_temp_files ]<br>
 145 [ --results_file='string' ]<br>
 146 [ --retries=integer ]<br>
 147 [ --run_on_nordugrid ]<br>
 148 [ --seed='string' ]<br>
 149 [ --threads=integer ]<br>
 150 [ --tweak_inits ]</tt>
 151 <h3 class="heading1">Description</h3>
 152 <p> The Case-deletion Diagnostics tool is run from the command line
 153 with a few mandatory arguments. It is run as a diagnostic after
 154 a model is regarded finished or at least mature enough for validation. You need to specify the NONMEM model file
 155 with a model that has successful termination. You also have to
 156 specify the number or the name of the  column in the data file, on which to
 157 select for deletion. This is done with the case_column option.</p>
 158 <h3 class="heading1">Options</h3>
 159 <p>
 160 The options are given here in their long form. Any option may be
 161 abbreviated to any nonconflicting prefix. The <span class="style2">-threads</span> option
 162 may be abbreviated to <span class="style2">-t </span>(or even <span class="style2">-thr</span>) but <span class="style2">-debug</span> may not be
 163 abbreviated to -d because it conflicts with <span class="style2">-debug_packages</span> and<span class="style2">-debug_subroutines</span>.</p>
 164 <p> The following options are valid:</p>
 165 <p class="style2"> -h | -?</p>
 166 <p> With -h or -? cdd will print a list of options and then exit.</p>
 167 <p class="style2"> -help</p>
 168 <p> With -help cdd will print a longer help message.</p>
 169 <p class="style2"> -bins=number</p>
 170 <p> Sets the number of data bins or cdd data sets that should be used. If the
 171   number of unique values or factors in the based_on column is
 172   higher than the number of bins,  one or more factors will be
 173   deleted in each of the cdd data set. Specifying bins as higher than
 174   the number of factors will have no effect. In that case the bin number will be
 175    set to the number of factors.
 176   The default value is equal to the number of unique values in the based_on column.</p>
 177 <p class="style2"> -selection_method='random' or 'consecutive'</p>
 178 <p> Specifies whether the factors selected for exclusion should be
 179   drawn randomly or consecutively from the data file.
 180   Default value = 'consecutive'</p>
 181 <p class="style2"> -case_column=column_name|column_number</p>
 182 <p> See the <a href="execute_docs.php">execute documentation</a> for a description of common options.</p>
 183 <h3 class="heading1">Output</h3>
 184 <p>The Case-deletion Diagnostics tool creates a log file and a result file. Both are by default placed in the cdd_dirX directory and are called cdd.csv and cdd-results.csv. </p>
 185 <p class="heading1">Example</p>
 186 <p class="style2">
 187       cdd modelfile.mod -case_column=10
 188 </p>
 189 <p>
 190       This will perform a Case-deletion Diagnostic  based on the factors in column number ten. If,
 191       for example, that column holds the names of the seven centers
 192       included in the study, this command will create seven copies of
 193       the data set, each with individuals from one specific
 194       center deleted. Say that the centers are numbered 1 to 7. Then
 195       all individuals from center 1 will be excluded from data set 1, the individuals from center 2 will be excluded from data set 2,  and so on.
 196 </p>
 197 </div>
 198 </div>
 199 <table border="0" cellpadding="0" cellspacing="0" width="780">
 200   <tbody>
 201     <tr>
 202       <td height="600" width="780">
 203       <table border="0" cellpadding="0" cellspacing="0" width="780">
 204         <tbody>
 205           <tr>
 206             <td colspan="7" height="201" width="780"><img
 207  src="images/indexpane1_1_.jpg" name="" alt="" border="0" height="201"
 208  width="780"></td>
 209           </tr>
 210           <tr>
 211             <td height="46" width="26"><img
 212  src="images/indexpane1_2_.jpg" name="" alt="" border="0" height="46"
 213  width="26"></td>
 214             <td height="46" width="73"><a href="index.php"
 215  onmouseover="changeImages(/*CMP*/ 'object', /*URL*/ 'images/indexhomeov.jpg'); return true;"
 216  onmouseout="changeImages(/*CMP*/ 'object', /*URL*/ 'images/indexhome.jpg'); return true;"><img
 217  src="images/indexhome.jpg" name="object" alt="Home" border="0"
 218  height="46" width="73"></a></td>
 219             <td height="46" width="11"><img
 220  src="images/indexpane3_2_.jpg" name="" alt="" border="0" height="46"
 221  width="11"></td>
 222             <td height="46" width="25"><img
 223  src="images/indexpane4_2_.jpg" name="" alt="" border="0" height="46"
 224  width="25"></td>
 225             <td height="46" width="15"><img
 226  src="images/indexpane5_2_.jpg" name="" alt="" border="0" height="46"
 227  width="15"></td>
 228             <td height="46" width="40"><img
 229  src="images/indexpane6_2_.jpg" name="" alt="" border="0" height="46"
 230  width="40"></td>
 231             <td height="46" width="590"><img
 232  src="images/indexpane7_2_.jpg" name="" alt="" border="0" height="46"
 233  width="590"></td>
 234           </tr>
 235           <tr>
 236             <td colspan="7" height="7" width="780"><img
 237  src="images/indexpane1_3_.jpg" name="" alt="" border="0" height="7"
 238  width="780"></td>
 239           </tr>
 240           <tr>
 241             <td height="46" width="26"><img
 242  src="images/indexpane1_4_.jpg" name="" alt="" border="0" height="46"
 243  width="26"></td>
 244             <td colspan="5" height="46" width="164"><a href="docs.php"
 245  onmouseover="changeImages(/*CMP*/ 'object1', /*URL*/ 'images/indexdocumentationov.jpg'); return true;"
 246  onmouseout="changeImages(/*CMP*/ 'object1', /*URL*/ 'images/indexdocumentation.jpg'); return true;"><img
 247  src="images/indexdocumentation.jpg" name="object1" alt="Documentation"
 248  border="0" height="46" width="164"></a></td>
 249             <td height="46" width="590"><img
 250  src="images/indexpane7_4_.jpg" name="" alt="" border="0" height="46"
 251  width="590"></td>
 252           </tr>
 253           <tr>
 254             <td colspan="7" height="7" width="780"><img
 255  src="images/indexpane1_5_.jpg" name="" alt="" border="0" height="7"
 256  width="780"></td>
 257           </tr>
 258           <tr>
 259             <td height="46" width="26"><img
 260  src="images/indexpane1_6_.jpg" name="" alt="" border="0" height="46"
 261  width="26"></td>
 262             <td colspan="3" height="46" width="109"><a
 263  href="download.php"
 264  onmouseover="changeImages(/*CMP*/ 'object2', /*URL*/ 'images/indexdownloadov.jpg'); return true;"
 265  onmouseout="changeImages(/*CMP*/ 'object2', /*URL*/ 'images/indexdownload.jpg'); return true;"><img
 266  src="images/indexdownload.jpg" name="object2" alt="Download" border="0"
 267  height="46" width="109"></a></td>
 268             <td colspan="3" height="46" width="645"><img
 269  src="images/indexpane5_6_.jpg" name="" alt="" border="0" height="46"
 270  width="645"></td>
 271           </tr>
 272           <tr>
 273             <td colspan="7" height="7" width="780"><img
 274  src="images/indexpane1_7_.jpg" name="" alt="" border="0" height="7"
 275  width="780"></td>
 276           </tr>
 277           <tr>
 278             <td height="46" width="26"><img
 279  src="images/indexpane1_8_.jpg" name="" alt="" border="0" height="46"
 280  width="26"></td>
 281             <td colspan="2" height="46" width="84"><a href="buglist.php"
 282  onmouseover="changeImages(/*CMP*/ 'object3', /*URL*/ 'images/indexbuglistov.jpg'); return true;"
 283  onmouseout="changeImages(/*CMP*/ 'object3', /*URL*/ 'images/indexbuglist.jpg'); return true;"><img
 284  src="images/indexbuglist.jpg" name="object3" alt="Buglist" border="0"
 285  height="46" width="84"></a></td>
 286             <td colspan="4" height="46" width="670"><img
 287  src="images/indexpane4_8_.jpg" name="" alt="" border="0" height="46"
 288  width="670"></td>
 289           </tr>
 290           <tr>
 291             <td colspan="7" height="7" width="780"><img
 292  src="images/indexpane1_9_.jpg" name="" alt="" border="0" height="7"
 293  width="780"></td>
 294           </tr>
 295           <tr>
 296             <td height="46" width="26"><img
 297  src="images/indexpane1_10_.jpg" name="" alt="" border="0" height="46"
 298  width="26"></td>
 299             <td colspan="4" height="46" width="124"><a href="list.php"
 300  onmouseover="changeImages(/*CMP*/ 'object4', /*URL*/ 'images/indexmailing_listov.jpg'); return true;"
 301  onmouseout="changeImages(/*CMP*/ 'object4', /*URL*/ 'images/indexmailing_list.jpg'); return true;"><img
 302  src="images/indexmailing_list.jpg" name="object4" alt="Mailing List"
 303  border="0" height="46" width="124"></a></td>
 304             <td colspan="2" height="46" width="630"><img
 305  src="images/indexpane6_10_.jpg" name="" alt="" border="0" height="46"
 306  width="630"></td>
 307           </tr>
 308           <tr>
 309             <td colspan="7" height="141" width="780"><img
 310  src="images/indexpane1_11_.jpg" name="" alt="" border="0" height="141"
 311  width="780"></td>
 312           </tr>
 313         </tbody>
 314       </table>
 315       </td>
 316     </tr>
 317     <tr>
 318       <td><img src="images/is_single_pixel_gif.gif" alt="" height="1"
 319  width="780"></td>
 320     </tr>
 321   </tbody>
 322 </table>
 323 <!--Adobe(R) LiveMotion(TM) DataMap1.0 DO NOT EDIT
 324 end DataMap -->
 325 </body>
 326 </html>