From d483c1112e838440f332efece783b20d980d42af Mon Sep 17 00:00:00 2001 From: Justin Bedo Date: Tue, 2 Aug 2016 16:27:11 +1000 Subject: Initial implementation --- man/pmt-package.Rd | 26 ++++++++++++++++++++++++++ man/pmt.Rd | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 man/pmt-package.Rd create mode 100644 man/pmt.Rd (limited to 'man') diff --git a/man/pmt-package.Rd b/man/pmt-package.Rd new file mode 100644 index 0000000..5c653d1 --- /dev/null +++ b/man/pmt-package.Rd @@ -0,0 +1,26 @@ +\name{pmt-package} +\alias{pmt-package} +\alias{pmt} +\docType{package} +\title{ +\packageTitle{pmt} +Poisson Margin Test +} +\description{ +\packageDescription{pmt} +Computes p-values using the Poission Margin Test for two vectors of counts arising from NGS data. +} +\details{ +\packageDESCRIPTION{pmt} +\packageIndices{pmt} +} +\author{ +\packageAuthor{pmt} + +Maintainer: \packageMaintainer{pmt} +} +\references{ +Kowalczyk, A., Bedő, J., Conway, T., Beresford-Smith, B., 2011. The Poisson margin test for normalization-free significance analysis of NGS data. Journal of Computational Biology 18, 391–400. doi:10.1089/cmb.2010.0272 +} +\keyword{NGS} +\keyword{Poisson} diff --git a/man/pmt.Rd b/man/pmt.Rd new file mode 100644 index 0000000..c9e0250 --- /dev/null +++ b/man/pmt.Rd @@ -0,0 +1,33 @@ +\name{pmt} +\alias{pmt} +\title{Poisson Margin Test} +\description{ + Computes p-values for two sets of counts using the Poisson Margin Test. +} +\usage{ +pmt(a, b) +} +\arguments{ + \item{a}{ + Vector of counts +} + \item{b}{ + Vector of counts +} +} +\details{ + This function computes the Poisson Margin Test (PMT) for two sets of counts. +} +\value{ + A vector of log10 p-values is returned, corresponding to the input vectors. +} +\references{ +Kowalczyk, A., Bedő, J., Conway, T., Beresford-Smith, B., 2011. The Poisson margin test for normalization-free significance analysis of NGS data. Journal of Computational Biology 18, 391–400. doi:10.1089/cmb.2010.0272 +} +\author{ + Justin Bedő +} +%\examples{ +%} +\keyword{NGS} +\keyword{Poisson} -- cgit v1.2.3