[Genabel-commits] r1521 - pkg/ProbABEL/doc

[noreply at r-forge.r-project.org]

Author: lckarssen
Date: 2014-01-02 01:26:55 +0100 (Thu, 02 Jan 2014)
New Revision: 1521

Added:
   pkg/ProbABEL/doc/probabel.pl.1
Modified:
   pkg/ProbABEL/doc/Makefile.am
   pkg/ProbABEL/doc/pacoxph.1
   pkg/ProbABEL/doc/palinear.1
   pkg/ProbABEL/doc/palogist.1
   pkg/ProbABEL/doc/probabel.1
Log:
Changing the ProbABEL man-pages:
- Add a man-page for probabel.pl (just a symlink to probabel.1)
- Reformat the example in probabel.1
- Update the date in the man-pages
- Mention the version number in the man-pages


Modified: pkg/ProbABEL/doc/Makefile.am
===================================================================
--- pkg/ProbABEL/doc/Makefile.am	2013-12-30 17:43:01 UTC (rev 1520)
+++ pkg/ProbABEL/doc/Makefile.am	2014-01-02 00:26:55 UTC (rev 1521)
@@ -6,7 +6,7 @@
  test.mlinfo test_regression.R COPYING LICENSE INSTALL ChangeLog	\
  TODO
 
-man_MANS = probabel.1
+man_MANS = probabel.1 probabel.pl.1
 if BUILD_palinear
 man_MANS += palinear.1
 endif

Modified: pkg/ProbABEL/doc/pacoxph.1
===================================================================
--- pkg/ProbABEL/doc/pacoxph.1	2013-12-30 17:43:01 UTC (rev 1520)
+++ pkg/ProbABEL/doc/pacoxph.1	2014-01-02 00:26:55 UTC (rev 1521)
@@ -1,4 +1,4 @@
-.TH pacoxph 1 "25 November 2013"
+.TH pacoxph 1 "2 January 2014" "ProbABEL 0.4.2"
 .SH NAME
 pacoxph \- Perform Genome-Wide Association Analysis using a linear model
 .SH SYNOPSIS

Modified: pkg/ProbABEL/doc/palinear.1
===================================================================
--- pkg/ProbABEL/doc/palinear.1	2013-12-30 17:43:01 UTC (rev 1520)
+++ pkg/ProbABEL/doc/palinear.1	2014-01-02 00:26:55 UTC (rev 1521)
@@ -1,4 +1,4 @@
-.TH palinear 1 "25 November 2013"
+.TH palinear 1 "2 January 2014" "ProbABEL 0.4.2"
 .SH NAME
 palinear \- Perform Genome-Wide Association Analysis using a linear model
 .SH SYNOPSIS
@@ -76,7 +76,7 @@
 Print help.
 
 .SH "SEE ALSO"
-palogist(1), pacoxph(1)
+probabel(1), palogist(1), pacoxph(1)
 .SH BUGS
 The bugtracker is located at
 .br

Modified: pkg/ProbABEL/doc/palogist.1
===================================================================
--- pkg/ProbABEL/doc/palogist.1	2013-12-30 17:43:01 UTC (rev 1520)
+++ pkg/ProbABEL/doc/palogist.1	2014-01-02 00:26:55 UTC (rev 1521)
@@ -1,4 +1,4 @@
-.TH palogist 1 "25 November 2013"
+.TH palogist 1 "2 January 2014" "ProbABEL 0.4.2"
 .SH NAME
 palogist \- Perform Genome-Wide Association Analysis using a linear model
 .SH SYNOPSIS
@@ -76,7 +76,7 @@
 Print help.
 
 .SH "SEE ALSO"
-palinear(1), pacoxph(1)
+probabel(1), palinear(1), pacoxph(1)
 .SH BUGS
 The bugtracker is located at
 .br

Modified: pkg/ProbABEL/doc/probabel.1
===================================================================
--- pkg/ProbABEL/doc/probabel.1	2013-12-30 17:43:01 UTC (rev 1520)
+++ pkg/ProbABEL/doc/probabel.1	2014-01-02 00:26:55 UTC (rev 1521)
@@ -1,4 +1,4 @@
-.TH probabel 1 "12 December 2013"
+.TH ProbABEL 1 "2 January 2014" "ProbABEL 0.4.2"
 .SH NAME
 probabel \- Wrapper around the three ProbABEL binaries, simplifying their use
 .SH SYNOPSIS
@@ -70,4 +70,22 @@
 the other options needs to be specified.
 
 .SH EXAMPLES
+This runs a genome-wide association scan using linear regression and
+the additive genetic model on cohort \fIMy_Large_Cohort\fR for
+phenotype \fImy_phenotype\fR:
+.PP
+.nf
+.RS
 probabel 1 22 linear "My_Large_Cohort" \-\-additive my_phenotype
+.RE
+.fi
+.PP
+
+.SH "SEE ALSO"
+palinear(1), palogist(1), pacoxph(1)
+.SH BUGS
+The bugtracker is located at
+.br
+https://r-forge.r-project.org/tracker/?group_id=505
+.SH AUTHORS
+Lennart C. Karssen

Added: pkg/ProbABEL/doc/probabel.pl.1
===================================================================
--- pkg/ProbABEL/doc/probabel.pl.1	                        (rev 0)
+++ pkg/ProbABEL/doc/probabel.pl.1	2014-01-02 00:26:55 UTC (rev 1521)
@@ -0,0 +1 @@
+link probabel.1
\ No newline at end of file


Property changes on: pkg/ProbABEL/doc/probabel.pl.1
___________________________________________________________________
Added: svn:special
   + *