.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" 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 >0, 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "ALTREE-ADD-S 1p" .TH ALTREE-ADD-S 1p "2015-12-09" "perl v5.24.1" "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.