User Tools

Site Tools


readme.renumf90

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
readme.renumf90 [2018/06/05 23:50] – [Options] danireadme.renumf90 [2024/05/22 18:53] (current) – [Options] dani
Line 1: Line 1:
- 
 =======RENUMF90====== =======RENUMF90======
 A renumbering program for the ''BLUPF90'' family now works with SNP info\\ A renumbering program for the ''BLUPF90'' family now works with SNP info\\
Line 21: Line 20:
   * missing animals have code 0; 00 may be treated as a known animal   * missing animals have code 0; 00 may be treated as a known animal
  
 +\\ 
 +**Hint**: type ''renumf90 %%--%%show-template''  to have a template parameter file.
 =====Structure of parameter file====== =====Structure of parameter file======
  
Line 37: Line 37:
 =====Fields in the parameter file===== =====Fields in the parameter file=====
  
-# Parameter file for program renf90; it is translated to parameter +# Parameter file for renumf90. It is translated into a parameter file for the BLUPF90 family of programs.
-file for BLUPF90 family of programs.+
  
 Lines with # are treated as comments Lines with # are treated as comments
Line 68: Line 67:
 <file> <file>
 WEIGHT(S) WEIGHT(S)
-w+w1 [w2 w3...wn] 
 </file> </file>
-w is  position of weight if present; can be empty+w1 [w2 w3...wn] are  position of weight(s) if present; can be empty (which means weight of 1 or no weight). Either there is a single weight, the same for all traits, or one weight per trait in which case ''ntrait'' positions are needed in this line. See [[readme.blupf90plus#weights|blupf90+ section on WEIGHTS]]  for details.
  
 <file> <file>
Line 86: Line 85:
 positions can be different for each trait for fixed effects; positions can be different for each trait for fixed effects;
  
-for random effects, only one position + 0 (misising) efefct are+for random effects, only one position + 0 (missing) efefct are
 possible.  possible. 
   * type is 'cross' for crossclassified or 'cov' for covariables   * type is 'cross' for crossclassified or 'cov' for covariables
-  * form is 'alpha' for alphanumeric or 'numer' for numeric+  * for crossclassified effects: form is 'alpha' for alphanumeric or 'numer' for numeric 
 +  * for covariables: neither 'alpha' nor 'numer' are needed; don't put anything after 'cov'
  
 <file> <file>
Line 183: Line 183:
 the default is 3 the default is 3
  
-all pedigrees are loaded if p=0.+all pedigrees are loaded if p=0. This is the fastest as it reads the pedigree file only once. However, if you want to extract the informative animals (genotyped and phenotyped animals + their ancestors traced back) put a large number like 100. With p=0, RENUMF90 tries to include all animals found in the raw pedigree file even if the animals in the pedigree are not related to the animals with phenotype or genotype. Thus, p=0 is not recommended unless your pedigree file is already prepared and consists in the informative animals or the animals of interest. 
  
 <file> <file>
Line 218: Line 219:
        
   * if t is 'internal',  allocation is by a user-written function custom_upg(year_of_birth,sex,ID, parent_code); not yet implemented.   * if t is 'internal',  allocation is by a user-written function custom_upg(year_of_birth,sex,ID, parent_code); not yet implemented.
 +
 +  * There are the other values for t: 'group', 'group_unisex', and 'group_sex'. See below for details.
 +
 <file> <file>
 INBREEDING INBREEDING
Line 223: Line 227:
 </file> </file>
 optional\\ optional\\
-use of inbreeding coefficients to compute inb/upg code in the 4th column of the output pedigree file+use of inbreeding coefficients to compute inb/upg code in the 4th column of the output pedigree file. Inbreeding calculation is a default in RENUMF90 ≥ v1.157, even if this keyword is not used.
  
 //inb_type// could be: //inb_type// could be:
   * 'pedigree' - the program computes inbreeding coefficients with Meuwissen and Luo (1992) using the pedigree to be saved in renaddxx.ped; calculated inbreeding coefficients will be saved in a file "renf90.inb" with the original ID   * 'pedigree' - the program computes inbreeding coefficients with Meuwissen and Luo (1992) using the pedigree to be saved in renaddxx.ped; calculated inbreeding coefficients will be saved in a file "renf90.inb" with the original ID
-  * 'file' - the program reads inbreeding coefficients from an external file. You should put the filename after 'file' e.g. 'file inbreeding.txt'. The file has at least 2 columns: original_ID and inbreeding value (from 0.0 to 1.0). The program just skips unnecessary IDs+  * 'file' - the program reads inbreeding coefficients from an external file. You should put the filename after 'file' e.g. 'file inbreeding.txt'. For instance a file "renf90.inb" (see above) from a previous run can be used. The file has at least 2 columns: original_ID and inbreeding value (from 0.0 to 1.0). The program just skips unnecessary IDs 
 +  * 'self x' - Calculates inbreeding with selfing, where x is the column in the pedigree file with the number of selfing generation 
 +  * 'no-inbreeding' - turn inbreeding calculation off in RENUMF90 ≥ v1.157
  
 <file> <file>
Line 246: Line 252:
 //r_type// could be: //r_type// could be:
   * 'data' if covariables for random regressions are in the data   * 'data' if covariables for random regressions are in the data
-  * "legendre' if legendre plynomials are to be generated from a single data variable; not yet implemented+  * "legendre' if legendre polynomials are to be generated from a single data variable; fully implemented now
  
 <file> <file>
Line 255: Line 261:
  
   * //r1-rq// specifies positions of covariables if r_type='data'   * //r1-rq// specifies positions of covariables if r_type='data'
-  * //r1// is order of legendre polynomial and //r2// is position of covariable if r_type='legendre'; not yet implemented+  * //r1// is order of legendre polynomial and //r2// is position of covariable if r_type='legendre'
  
 <file> <file>
Line 281: Line 287:
 ==== User-defined UPG code ==== ==== User-defined UPG code ====
  
-The program accepts the following keywords in ''UPG_TYPE''.+See [[undoc:renumf90|a separate documentation]] for details.
  
-    UPG_TYPE +The program accepts one of the following keywords in ''UPG_TYPE'': ''group'', ''group_unisex'', and ''group_sex''. 
-    group +With one of these options, the program looks at a particular column in the pedigree file as a group code and use it for assigning the UPG code. If an animal has a missing parent, the program assigns a UPG code based on the group code.
-     +
-    or +
-     +
-    UPG_TYPE +
-    group_unisex+
  
-With this option, the program looks at a particular column in the pedigree file as a group code and saves it. If an animal has a missing parent, the program assigns an UPG code according to the group code. If you want to assign separate UPGs by the parent's sex (sire or dam), use ''group''The ''group_unisex'' doesn't consider the sex of parents.+  * ''group_unisex'': The program assigns UPG code to the unknown parent regardless of the parent's sex
 +  * ''group''The program assigns a separate UPG code to the unknown sire and dam. 
 +  * ''group_sex'': The user can specify a sex-specific UPG in the original pedigree file.
  
-The column in the pedigree file is specified with the 6th item in ''FILE_POS''. The following example tells the program the 5th column in the pedigree file as the group code. The group code will be treated as characters.+For ''group_unisex'' and ''group'', the column in the pedigree file is specified with the 6th item in ''FILE_POS''. The following example tells the program the 5th column in the pedigree file as the group code. The group code will be treated as characters.
  
     FILE_POS     FILE_POS
     1 2 3 0 0 5     1 2 3 0 0 5
  
-The program now accept 3 items5 items, or 6 items in ''FILE_POS''.+For ''group_sex''you need two additional columns in the pedigree file: one is for an unknown sire, and the other is for an unknown dam. For example, assume the 5th column is for unknown sire, and the 6th column is for unknown dam, the ''FILE_POS'' entry has 7 items.
  
 +    FILE_POS
 +    1 2 3 0 0 5 6
  
 +The program now accept 3, 5, 6, or 7 items in ''FILE_POS''.
  
 =====Extra comments===== =====Extra comments=====
Line 319: Line 325:
  
 =====Options===== =====Options=====
-The following options can added at the end of the parameter file to redefine+The following options can be added at the end of the parameter file to redefine
 parameters used to read the input file: parameters used to read the input file:
  
Line 328: Line 334:
 where //nn// is the new size. where //nn// is the new size.
  
- - the size of th record length (default = 800) + - the size of the record length (default = 800) 
 <file> <file>
 OPTION max_string_readline nn OPTION max_string_readline nn
Line 334: Line 340:
 where //nn// is the new size. where //nn// is the new size.
  
- - the maximun number of fields (default = 100) + - the maximum number of fields (default = 100) 
 <file> <file>
 OPTION max_field_readline nn OPTION max_field_readline nn
Line 340: Line 346:
 where //nn// is the number of fields.  where //nn// is the number of fields. 
  
 +<file>
 +OPTION missing x
 +</file>
 +
 +allows indicating that the missing value is the number x (e.g., 999), for instance, if 0 is a valid record. This is only to represent the missing value in the data. If there are covariables in the data, 0 is treated as a value, not missing information. Missing pedigree is always 0 and cannot be changed to another value. 
 +
 +<file>
 +OPTION remove_all_missing
 +</file>
 +
 +removes lines in the data where phenotypes are missing. Keeping those lines may cause unexpected behavior in some programs.
 +
 +<file>
 +OPTION missing_in_weights
 +</file>
 +
 +in addition, this indicates that if a weight for the trait is 0, then the value of the trait is converted to "missing" in the output file ''renf90.dat'', i.e. 0 by default or another value is set if  ''OPTION missing '' is used. 
 +
 +<file>
 +OPTION no_basic_statistics
 +</file>
 +avoids the computation of basic statistics (min, max, correlations, ...), which take a certain time for very large data file.
 +
 +<file>
 +OPTION inbreeding_method m
 +</file>
 +
 +allows choosing a method for inbreeding calculation. The inbreeding coefficients are used later (in the other programs) to set up the coefficients for the A-inverse. Acceptable values for m are:
 +  
 +  1: Meuwissen and Luo (1992)
 +  2: Modified Meuwissen & Luo by Sargolzaei & Iwaisaki (2004)
 +  3: Modified Colleau by Sargolzaei et al. (2005) 
 +  4: recursive tabular method 
 +  5: method of Tier (1990)
 +  6: Hybrid parallel computing, which is basically a parallel (OMP) version of Meuwissen and Luo (1992)
 +  7: Recursive tabular with self-breeding generations. For populations with selfing, i.e., wheat
 +
 +The default is method 1. Large speed-ups are made using method 6, but this requires using several threads (e.g., using ''OMP_NUM_THREADS=4'')
    
 The end of the parameter file for ''RENUMF90'' can contain many lines beginning with OPTION.  The end of the parameter file for ''RENUMF90'' can contain many lines beginning with OPTION. 
  
-All of these lines are passed to parameter file renf90.par to be used by application programs. +All of these lines are passed to the parameter file renf90.par to be used by application programs. 
  
  
Line 377: Line 421:
    2) parent 1 number or unknown parent group number for parent 1       2) parent 1 number or unknown parent group number for parent 1   
    3) parent 2 number or unknown parent group number for parent 2       3) parent 2 number or unknown parent group number for parent 2   
-   4) 3 minus number of known parents                               +   4) 3 minus number of known parents or inbreeding code if inbreeding is used (inbreeding is default now)                              
    5) known or estimated year of birth (0 if not provided)              5) known or estimated year of birth (0 if not provided)          
    6) number of known parents (parents might be eliminated if not contributing;    6) number of known parents (parents might be eliminated if not contributing;
readme.renumf90.txt · Last modified: 2024/05/22 18:53 by dani

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki