Commit e96ae544 authored by damien's avatar damien
Browse files

Little tweaks to the manpages.

parent 5ec867ec
......@@ -17,11 +17,11 @@ spell-marker – Compute the 1-point Parental Origin Probabilities in a pedigree
It outputs a data file that can be used with **spell-qtl** to compute the n-point Parental Origin Probabilities and
perform the actual QTL analysis.
**spell-marker** expects that **spell-pedigree** has been run beforehand with the same working directory and configuration name.
Because each marker is supposed to be independent, **spell-marker** can perform the computations in parallel in a
variety of ways. See the *Job control* subsection of the options for details.
**spell-marker** expects that **spell-pedigree** has been run beforehand with the same working directory and configuration name.
**-wd**,**--work-directory** *PATH*
: Path to directory for cache files and outputs. Defaults to the **current directory**.
......@@ -173,6 +173,10 @@ encompasses.
}
}
~~~~
# EXAMPLES
See `spell-qtl-examples` (1) for complete examples of the spell-qtl pipeline.
# SEE ALSO
`spell-pedigree` (1), `spell-qtl` (1), `spell-qtl-examples` (1).
\ No newline at end of file
`spell-pedigree` (1), `spell-qtl` (1), `spell-qtl-examples` (1).
......@@ -53,6 +53,10 @@ Probabilities for this pedigree given allelic or genotype observations on a set
**spell-pedigree** will create a file named *NAME***.spell-pedigree.data** in the directory **WORK_DIRECTORY/*NAME*.cache**.
# EXAMPLES
See `spell-qtl-examples` (1) for complete examples of the spell-qtl pipeline.
# SEE ALSO
`spell-marker` (1), `spell-qtl` (1), `spell-qtl-examples` (1).
\ No newline at end of file
`spell-marker` (1), `spell-qtl` (1), `spell-qtl-examples` (1).
......@@ -8,7 +8,7 @@ spell-qtl-examples – Example datasets for the spell-qtl software suite.
# DESCRIPTION
The datasets are located in /usr/local/share/spell-qtl/examples if it was installed system-wide, or share/spell-qtl/examples
The datasets are located in /usr/share/spell-qtl/examples if it was installed system-wide, or share/spell-qtl/examples
in the installation directory.
The example datasets each consist in a set of files :
......@@ -21,4 +21,4 @@ Additionally, a **README** file in each directory describes the dataset features
# SEE ALSO
`spell-pedigree` (1), `spell-marker` (1), `spell-qtl` (1)
\ No newline at end of file
`spell-pedigree` (1), `spell-marker` (1), `spell-qtl` (1)
......@@ -124,6 +124,10 @@ The standard pipeline is:
**QTL-detection** *ALGORITHM*
: Specify the QTL detection algorithm. Available algorithms are *none*, *CIM*, *CIM-*, *iQTLm*, and *iQTLm-GW*. The default algorithm is *iQTLm*.
# EXAMPLES
See `spell-qtl-examples` (1) for complete examples of the spell-qtl pipeline.
# SEE ALSO
`spell-pedigree` (1), `spell-qtl` (1), `spell-qtl-examples` (1).
\ No newline at end of file
`spell-pedigree` (1), `spell-qtl` (1), `spell-qtl-examples` (1).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment