Difference between revisions of "Parameter file elements"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
=<'''pedigrees'''>= | =<'''pedigrees'''>= | ||
{{tableele1| | {{tableele1| | ||
<syntaxhighlight lang="xml" line> | {{!}}<syntaxhighlight lang="xml" line> | ||
<root> | <root> | ||
.. | .. | ||
Line 10: | Line 10: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''root''' | |||
{{!}}automatic-optional | |||
{{!}}hosts one to several elements each containing information about a specific pedigree}} | |||
content: | content: | ||
Line 26: | Line 26: | ||
*nominated-compulsory elements | *nominated-compulsory elements | ||
==<''pedigree name''>== | ==<''pedigree name''>== | ||
{{tableele1|<syntaxhighlight lang="xml" line> | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 41: | Line 42: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''pedigrees''' | |||
{{!}}nominated-compulsory | |||
{{!}}hosts information about a specific pedigree identified by ''pedigree name'' | |||
}} | }} | ||
content: | content: | ||
*key strings | *key strings | ||
{{tablekeys2| | {{tablekeys2| | ||
{{!}}'''file''' | |||
{{!}}'''file''': ''myped.csv'' | {{!}}'''file''': ''myped.csv'' | ||
{{!}}compulsory | {{!}}compulsory | ||
Line 76: | Line 77: | ||
=<'''genotypes'''>= | =<'''genotypes'''>= | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 91: | Line 87: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''root''' | |||
{{!}}automatic-optional | |||
{{!}}hosts one to several elements each containing information about different sets of genotypes | |||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekeys2| | ||
{{!}}'''genotypes''' | |||
{{!}}'''genotypes''': ''a,b'' | |||
{{!}}compulsory | |||
{{!}}csv word-list | |||
{{!}}''genotype names'' | |||
{{!}}none | |||
{{!}}list content determines names of nominated-compulsory elements | |||
}} | |||
*nominated-compulsory elements | *nominated-compulsory elements | ||
==<''genotype name''>== | ==<''genotype name''>== | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 138: | Line 121: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''genotypes''' | |||
{{!}}nominated-compulsory | |||
{{!}}hosts information about a specific set of genotypes identified by ''genotype name'' | |||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekeys2| | ||
{{!}}'''file''' | |||
{{!}}'''file''': ''genotype.txt'' | |||
{{!}}compulsory | |||
{{!}}word | |||
{{!}}''file name'' | |||
{{!}}none | |||
{{!}}content determines the name of the file containing the genotypes | |||
{{!}}- | |||
{{!}}'''cross''' | |||
{{!}}'''cross''': ''mycross.csv'' | |||
{{!}}optional | |||
{{!}}word | |||
{{!}}''file name'' | |||
{{!}}none | |||
{{!}}content determines the name of the file containing the pedigree ids related to the genotypes | |||
{{!}}- | |||
{{!}}'''pedigree''' | |||
{{!}}'''pedigree''': ''myped'' | |||
{{!}}optional | |||
{{!}}word | |||
{{!}}''pedigree name'' | |||
{{!}}none | |||
{{!}}content determines the name of a pedigree previously invoked pedigree related to the content of the cross-reference file | |||
}} | |||
=<'''grms'''>= | =<'''grms'''>= | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 194: | Line 164: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''root''' | |||
{{!}}automatic-optional | |||
{{!}}hosts one to several elements each containing information about a specific grm | |||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekeys2| | ||
{{!}}'''grms''' | |||
{{!}}'''grms''': ''x,y'' | |||
{{!}}compulsory | |||
{{!}}csv word-list | |||
{{!}}''grm names'' | |||
{{!}}none | |||
{{!}}list content determines names of nominated-compulsory elements | |||
}} | |||
*nominated-compulsory elements | *nominated-compulsory elements | ||
==<''grm name''>== | ==<''grm name''>== | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 240: | Line 197: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''grms''' | |||
{{!}}nominated-compulsory | |||
{{!}}hosts information about a specific grm identified by ''grm name'' | |||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekeys2| | ||
{{!}}'''file''' | |||
{{!}}'''file''': ''mygrm.csv'' | |||
{{!}}compulsory | |||
{{!}}word | |||
{{!}}''file name'' | |||
{{!}}none | |||
{{!}}content determines the name of the file containing the grm. mutually exclusive with keyword '''genotype'''. | |||
{{!}}- | |||
{{!}}'''genotype''' | |||
{{!}}'''genotype''': ''mygn'' | |||
{{!}}compulsory | |||
{{!}}word | |||
{{!}}''genotype name'' | |||
{{!}}none | |||
{{!}}content determines the genotype element to be used for building the grm. mutually exclusive with keyword '''file'''. | |||
{{!}}- | |||
{{!}}'''cross''' | |||
{{!}}'''cross''': ''mycross.csv'' | |||
{{!}}optional | |||
{{!}}word | |||
{{!}}''file name'' | |||
{{!}}none | |||
{{!}}content determines the name of the file containing the pedigree ids related to the genotypes. if this information has already been supplied to the genotypes it cannot be supplied here. | |||
{{!}}- | |||
{{!}}'''pedigree''' | |||
{{!}}'''pedigree''': ''myped'' | |||
{{!}}optional | |||
{{!}}word | |||
{{!}}''pedigree name'' | |||
{{!}}none | |||
{{!}}content determines the name of a pedigree previously invoked pedigree related to the content of the cross-reference file. if this information has already been supplied to the genotypes it cannot be supplied here. | |||
{{!}}- | |||
{{!}}'''method''' | |||
{{!}}'''method''':'''YA''' | |||
{{!}}optional | |||
{{!}}alternative words | |||
{{!}}'''VR<nowiki>|</nowiki>YA''' | |||
{{!}}'''VR''' | |||
{{!}}content determines the method to be used for building a grm from genotypes | |||
*'''VR''': VanRaden Method 1 is used | *'''VR''': VanRaden Method 1 is used | ||
*'''YA''': VanRaden Method 2(method Yang) is used | *'''YA''': VanRaden Method 2(method Yang) is used | ||
}} | |||
=<'''vars'''>= | =<'''vars'''>= | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 314: | Line 258: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''root''' | |||
{{!}}compulsory | |||
{{!}}hosts one to several elements each containing information about a specific variance. | |||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekeys2| | ||
{{!}}'''vars''' | |||
{{!}}'''vars''': ''g,p'' | |||
{{!}}compulsory | |||
{{!}}csv word-list | |||
{{!}}''variance names'' | |||
{{!}}none | |||
{{!}}list content determines names of nominated-compulsory elements | |||
}} | |||
*nominated-compulsory elements | *nominated-compulsory elements | ||
*compulsory element '''<res>''' | *compulsory element '''<res>''' | ||
=='''<res>'''== | =='''<res>'''== | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 361: | Line 292: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''vars''' | |||
{{!}}compulsory | |||
{{!}}hosts information about the residual variance structure. | |||
}} | |||
content: | content: | ||
Line 371: | Line 302: | ||
==''<variance name>''== | ==''<variance name>''== | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 395: | Line 321: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''vars''' | |||
{{!}}nominated-compulsory | |||
{{!}}hosts information about variance structure identified by ''variance name''. | |||
}} | |||
content: | content: | ||
Line 405: | Line 331: | ||
==='''<sigma>'''=== | ==='''<sigma>'''=== | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 427: | Line 348: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}''variance name'' | |||
{{!}}compulsory | |||
{{!}}hosts information about $$\Sigma$$ as part of [[Supported_features#Supported_variance_structures|$$\Gamma \otimes \Sigma$$]]. | |||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekey2| | ||
{{!}}'''file''' | |||
{{!}}'''file''': ''mymatrix.csv'' | |||
{{!}}compulsory | |||
{{!}}word | |||
{{!}}''file name'' | |||
{{!}}none | |||
{{!}}content determines the name of the file containing the $$\Sigma$$ matrix. is mutually exclusive with '''<matrix attributes="array">'''. | |||
{{!}}- | |||
{{!}}'''type''' | |||
{{!}}'''type''': '''block''' | |||
{{!}}optional | |||
{{!}}word | |||
{{!}}'''block''' | |||
{{!}}none | |||
{{!}}determines that $$\Sigma$$ is equal to [[Supported_features#Supported_variance_structures|$$\Theta$$]] | |||
}} | |||
*optional element '''<matrix attributes="array">''' | *optional element '''<matrix attributes="array">''' | ||
==='''<gamma>'''=== | ==='''<gamma>'''=== | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 485: | Line 393: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}''variance name'' | |||
{{!}}optional | |||
{{!}}hosts information about $$\Gamma$$ as part of [[Supported_features#Supported_variance_structures|$$\Gamma \otimes \Sigma$$]]. | |||
}} | |||
content: | content: | ||
Line 495: | Line 403: | ||
===='''<A>'''==== | ===='''<A>'''==== | ||
{| | {{tableele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 519: | Line 422: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''gamma''' | |||
{{!}}compulsory | |||
{{!}}hosts information about $$\Gamma$$ being constructed as the numerator relationship matrix A using pedigree ''pedigree name''. | |||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekeys2| | ||
{{!}}'''pedigree''' | |||
{{!}}'''pedigree''': ''myped'' | |||
{{!}}optional | |||
{{!}}word | |||
{{!}}''pedigree name'' | |||
{{!}}none | |||
{{!}}content determines the name of a pedigree previously invoked to be used to construct A. | |||
}} | |||
===='''<H>'''==== | ===='''<H>'''==== | ||
{| | {{tablele1| | ||
{{!}}<syntaxhighlight lang="xml" line> | |||
<root> | <root> | ||
.. | .. | ||
Line 573: | Line 463: | ||
</root> | </root> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{!}}'''gamma''' | |||
{{!}}compulsory | |||
{{!}}hosts information about $$\Gamma$$ being constructed as combined single step relationship matrix H using pedigree ''pedigree name'' and genomic information. the genomic information can be supplied | |||
*via a grm element for single step H-BLUP models | *via a grm element for single step H-BLUP models | ||
*via a genotype element for single step T-BLUP models | *via a genotype element for single step T-BLUP models | ||
}} | |||
content: | content: | ||
*key strings | *key strings | ||
{| | {{tablekeys2| | ||
{{!}}'''pedigree''' | |||
{{!}}'''pedigree''': ''myped'' | |||
{{!}}compulsory | |||
{{!}}word | |||
{{!}}''pedigree name'' | |||
{{!}}none | |||
{{!}}content determines the name of a pedigree element to be used to construct H. | |||
{{!}}- | |||
{{!}}'''type''' | |||
{{!}}'''type''': '''tblup''' | |||
{{!}}optional | |||
{{!}}word | |||
{{!}}'''tblup<nowiki>|</nowiki>hblup''' | |||
{{!}}'''hblup''' | |||
{{!}}content determines the way the inverse of H is constructed. | |||
{{!}}- | |||
{{!}}'''grm''' | |||
{{!}}'''grm''': ''mygrm'' | |||
{{!}}compulsory | |||
{{!}}word | |||
{{!}}''pedigree name'' | |||
{{!}}none | |||
{{!}}content determines the grm element to be used to construct H. compulsory for hblup. | |||
}} | |||
===='''<E>'''==== | ===='''<E>'''==== |
Revision as of 05:01, 4 January 2021
<pedigrees>
example | host element | element type | purpose |
<root>
..
<pedigrees>
pedigrees: a,b
...
</pedigrees>
</root> |
root | automatic-optional | hosts one to several elements each containing information about a specific pedigree |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
pedigrees | pedigrees: a,b | compulsory | csv word-list | pedigree names | none | list content determines names of nominated-compulsory elements |
- nominated-compulsory elements
<pedigree name>
example | host element | element type | purpose |
<root>
..
<pedigrees>
pedigrees: myped
..
<myped>
file: myped.csv
switch: selfing
phantomparents: 2
</myped>
..
</pedigrees>
</root> |
pedigrees | nominated-compulsory | hosts information about a specific pedigree identified by pedigree name |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
file | file: myped.csv | compulsory | word | file name | none | list content determines the name of the file containing the pedigree |
switch | switch: selfing | optional | csv-word-list | selfing,probabilistic | none | list content determines pedigree properties.
|
phantomparents | phantomparents: 2 | optional | single numeric value | positive integer | none | integer number determines the number of individuals at the top of the pedigree which are phantom parents |
<genotypes>
example | host element | element type | purpose |
<root>
..
<genotypes>
genotypes: a,b
...
</genotypes>
</root> |
root | automatic-optional | hosts one to several elements each containing information about different sets of genotypes |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
genotypes | genotypes: a,b | compulsory | csv word-list | genotype names | none | list content determines names of nominated-compulsory elements |
- nominated-compulsory elements
<genotype name>
example | host element | element type | purpose |
<root>
..
<genotypes>
genotypes: mygn
..
<mygn>
file: genotypes.txt
pedigree: myped
cross: crossref.csv
</mygn>
..
</genotypes>
</root> |
genotypes | nominated-compulsory | hosts information about a specific set of genotypes identified by genotype name |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
file | file: genotype.txt | compulsory | word | file name | none | content determines the name of the file containing the genotypes |
cross | cross: mycross.csv | optional | word | file name | none | content determines the name of the file containing the pedigree ids related to the genotypes |
pedigree | pedigree: myped | optional | word | pedigree name | none | content determines the name of a pedigree previously invoked pedigree related to the content of the cross-reference file |
<grms>
example | host element | element type | purpose |
<root>
..
<grms>
grms: a,b
...
</grms>
</root> |
root | automatic-optional | hosts one to several elements each containing information about a specific grm |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
grms | grms: x,y | compulsory | csv word-list | grm names | none | list content determines names of nominated-compulsory elements |
- nominated-compulsory elements
<grm name>
example | host element | element type | purpose |
<root>
..
<grms>
grms: mygrm
..
<mygrm>
genotype: mygn
method: YA
</mygrm>
..
</genotypes>
</root> |
grms | nominated-compulsory | hosts information about a specific grm identified by grm name |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
file | file: mygrm.csv | compulsory | word | file name | none | content determines the name of the file containing the grm. mutually exclusive with keyword genotype. |
genotype | genotype: mygn | compulsory | word | genotype name | none | content determines the genotype element to be used for building the grm. mutually exclusive with keyword file. |
cross | cross: mycross.csv | optional | word | file name | none | content determines the name of the file containing the pedigree ids related to the genotypes. if this information has already been supplied to the genotypes it cannot be supplied here. |
pedigree | pedigree: myped | optional | word | pedigree name | none | content determines the name of a pedigree previously invoked pedigree related to the content of the cross-reference file. if this information has already been supplied to the genotypes it cannot be supplied here. |
method | method:YA | optional | alternative words | VR|YA | VR | content determines the method to be used for building a grm from genotypes
|
<vars>
example | host element | element type | purpose |
<root>
..
<vars>
vars: g,p
...
</vars>
</root> |
root | compulsory | hosts one to several elements each containing information about a specific variance. |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
vars | vars: g,p | compulsory | csv word-list | variance names | none | list content determines names of nominated-compulsory elements |
- nominated-compulsory elements
- compulsory element <res>
<res>
example | host element | element type | purpose |
<root>
..
<vars>
..
<res>
<sigma>
..
</sigma>
</res>
..
</vars>
</root> |
vars | compulsory | hosts information about the residual variance structure. |
content:
- compulsory element <sigma>
- optional element <gamma>
<variance name>
example | host element | element type | purpose |
<root>
..
<vars>
..
vars: myvar
<myvar>
<sigma>
..
</sigma>
<gamma>
..
</gamma>
</myvar>
..
</vars>
</root> |
vars | nominated-compulsory | hosts information about variance structure identified by variance name. |
content:
- compulsory element <sigma>
- optional element <gamma>
<sigma>
example | host element | element type | purpose |
<root>
..
<vars>
..
vars: myvar
<myvar>
<sigma>
..
</sigma>
..
</myvar>
..
</vars>
</root> |
variance name | compulsory | hosts information about $$\Sigma$$ as part of $$\Gamma \otimes \Sigma$$. |
content:
- key strings
- optional element <matrix attributes="array">
<gamma>
example | host element | element type | purpose |
<root>
..
<vars>
..
vars: myvar
<myvar>
<gamma>
..
</gamma>
..
</myvar>
..
</vars>
</root> |
variance name | optional | hosts information about $$\Gamma$$ as part of $$\Gamma \otimes \Sigma$$. |
content:
- mutually exclusive elements <A>, <H> and <E>
<A>
example | host element | element type | purpose |
<root>
..
<vars>
..
vars: myvar
<myvar>
<gamma>
<A>
pedigree: myped
</A>
</gamma>
..
</myvar>
..
</vars>
</root> |
gamma | compulsory | hosts information about $$\Gamma$$ being constructed as the numerator relationship matrix A using pedigree pedigree name. |
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
pedigree | pedigree: myped | optional | word | pedigree name | none | content determines the name of a pedigree previously invoked to be used to construct A. |
<H>
content:
- key strings
word | example | type | variable type | variable values | default | explanation |
pedigree | pedigree: myped | compulsory | word | pedigree name | none | content determines the name of a pedigree element to be used to construct H. |
type | type: tblup | optional | word | tblup|hblup | hblup | content determines the way the inverse of H is constructed. |
grm | grm: mygrm | compulsory | word | pedigree name | none | content determines the grm element to be used to construct H. compulsory for hblup. |
<E>
<model>
<eqn>
<poly>
<jobs>
Example:
<root>
..
<jobs>
jobs: solve,yh
...
</jobs>
</root>
host: root
content:
- key strings
example | type | variable type | variable values | default | explanation |
jobs: solve,yh | compulsory | csv word-list | solve,sample,pevsample,mcemreml,yh | none | job sequence is determined by the list sequence. list content determines nominated-compulsory elements |
- nominated-compulsory elements
<solve>
Example:
<root>
..
<jobs>
..
<solve>
solver: mysolver
</solve>
..
</jobs>
..
</root>
host: jobs
content:
- key strings
example | type | variable type | variable values | default | explanation |
solver: mysolver | compulsory | word | solver name | none | solver name must be the name of a previously defined solver |
<sample>
<pevsample>
<mcemreml>
<yh>
<samplers>
<sampler name>
<solvers>
- host: root
<solver name>
- host: solvers
- hosts mutually exclusive elements of which hard-coded names define the solver type
<pcgiod>
- host: solver name
- defines the solver is an iteration-on-data preconditioned gradient solver
element name | element type | host element | hosts elements | element function | key string key word | key string variable | key string function | key string type |
---|---|---|---|---|---|---|---|---|
pedigrees | Automatic-optional | root | yes | host elements of specific pedigrees | pedigrees | pedigree names | nominates further elements | compulsory |
pedigree name | Nominated-compulsory | pedigrees | no | host information about a specific pedigree | file | pedigree file name | provides pedigree file name | compulsory |
switch | probabilistic | pedigree is probabilistic | optional | |||||
selfing | pedigree contains selfing | |||||||
phantomparents | integer | provides the number of individuals at the top of the pedigree which are phantom parents | optional |