.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ALTREE-ADD-S 1p" .TH ALTREE-ADD-S 1p "2012-10-28" "perl v5.20.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" altree\-add\-S \- Title... .SH "SYNOPSIS" .IX Header "SYNOPSIS" altree-add-S [options] .PP .Vb 10 \& Options: \& \-\-version program version \& \-\-short\-help|h brief help message \& \-\-help help message with options descriptions \& \-\-man full documentation \& \-\-first\-input\-file|i input file 1 \& \-\-second\-input\-file|j input file 2 data concerning the trait (qualitative or quantitative) \& \-\-output\-file|o output file \& \-\-epsilon|e epsilon value \& \-\-data\-type|t data type: SNP or DNA \& \-\-proportion|p proportion of cases in the sample (for qualitative data only) \& \-\-data\-qual|q data type: qualitative or quantitative \& [\-\-outgroup|g] name of the outgroup \& \-\-low|l if an haplotype is present equal or less than \-l times, the state of S will be set to "?" .Ve .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-version\fR" 8 .IX Item "--version" Print the program version and exits. .IP "\fB\-\-short\-help\fR" 8 .IX Item "--short-help" Print a brief help message and exits. .IP "\fB\-\-help\fR" 8 .IX Item "--help" Print a help message with options descriptions and exits. .IP "\fB\-\-man\fR" 8 .IX Item "--man" Prints the manual page and exits. .IP "\fB\-\-first\-input\-file|i\fR" 8 .IX Item "--first-input-file|i" Input file 1 (paup or phylip file) .IP "\fB\-\-second\-input\-file|j\fR" 8 .IX Item "--second-input-file|j" Input file 2, contains the number of times a given haplotypes is carried by case and control individuals (qualitative data) or the quantitative values correqsponding to a givent haplotype (quantitative data) .IP "\fB\-\-output\-file|o\fR" 8 .IX Item "--output-file|o" Output file .IP "\fB\-\-epsilon|e\fR" 8 .IX Item "--epsilon|e" espilon parameter (see formula in the documentation) .IP "\fB\-\-data\-type|t\fR" 8 .IX Item "--data-type|t" Type of data: \s-1DNA \s0(\s-1ATGCU\s0) or \s-1SNP \s0(0\-1) .IP "\fB\-\-proportion|p\fR" 8 .IX Item "--proportion|p" Proportion of case individuals in the sample .IP "\fB\-\-outgroup|g\fR" 8 .IX Item "--outgroup|g" Name of the outgroup (if it is not in the file containing the number of cases and controls per haplotype) .IP "\fB\-\-data\-qual|q\fR" 8 .IX Item "--data-qual|q" Specify if the data are qualitative or quantitative .IP "\fB\-\-low|l\fR" 8 .IX Item "--low|l" if an haplotype is present equal or less than \-l times, the state of S will be set to \*(L"?\*(R" .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBThis program\fR adds a new character (called \*(L"character S\*(R") to each haplotype in the input file according to the number of cases and controls carrying it.