Skip to content

Commit

Permalink
fixed description - removed extra license file, and removed roxygen l…
Browse files Browse the repository at this point in the history
…ist wrap argument to make CRAN compliant
  • Loading branch information
stephenturner committed May 10, 2014
1 parent 2554be2 commit 8be6fd9
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 42 deletions.
3 changes: 1 addition & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Depends:
R (>= 3.0.0)
Suggests:
knitr
License: GPL-3 + file LICENSE
License: GPL-3
LazyData: true
VignetteBuilder: knitr
Roxygen: list(wrap = TRUE)
3 changes: 1 addition & 2 deletions man/gwasResults.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
\alias{gwasResults}
\title{Simulated GWAS results}
\description{
Simulated GWAS results as obtained from \code{plink
--assoc}.
Simulated GWAS results as obtained from \code{plink --assoc}.
}

54 changes: 22 additions & 32 deletions man/manhattan.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -9,53 +9,43 @@ manhattan(x, chr = "CHR", bp = "BP", p = "P", snp = "SNP",
highlight = NULL, ...)
}
\arguments{
\item{x}{A data.frame with columns "BP," "CHR," "P," and
optionally, "SNP."}
\item{x}{A data.frame with columns "BP," "CHR," "P," and optionally, "SNP."}

\item{chr}{A string denoting the column name for the
chromosome. Defaults to PLINK's "CHR." Said column must
be numeric. If you have X, Y, or MT chromosomes, be sure
to renumber these 23, 24, 25, etc.}
\item{chr}{A string denoting the column name for the chromosome. Defaults to
PLINK's "CHR." Said column must be numeric. If you have X, Y, or MT
chromosomes, be sure to renumber these 23, 24, 25, etc.}
\item{bp}{A string denoting the column name for the
chromosomal position. Defaults to PLINK's "BP." Said
column must be numeric.}
\item{bp}{A string denoting the column name for the chromosomal position.
Defaults to PLINK's "BP." Said column must be numeric.}

\item{p}{A string denoting the column name for the
p-value. Defaults to PLINK's "P." Said column must be
numeric.}
\item{p}{A string denoting the column name for the p-value. Defaults to
PLINK's "P." Said column must be numeric.}
\item{snp}{A string denoting the column name for the SNP
name (rs number). Defaults to PLINK's "SNP." Said column
should be a character.}
\item{snp}{A string denoting the column name for the SNP name (rs number).
Defaults to PLINK's "SNP." Said column should be a character.}

\item{col}{A character vector indicating which colors to
alternate.}
\item{col}{A character vector indicating which colors to alternate.}

\item{ymax}{The upper limit to the y-axis. Set
automatically based on the most significant SNP unless
set here specifically.}
\item{ymax}{The upper limit to the y-axis. Set automatically based on the
most significant SNP unless set here specifically.}

\item{suggestiveline}{Where to draw a "suggestive" line.
Default -log10(1e-5). Set to FALSE to disable.}
\item{suggestiveline}{Where to draw a "suggestive" line. Default
-log10(1e-5). Set to FALSE to disable.}

\item{genomewideline}{Where to draw a "genome-wide
sigificant" line. Default -log10(5e-8). Set to FALSE to
disable.}
\item{genomewideline}{Where to draw a "genome-wide sigificant" line. Default
-log10(5e-8). Set to FALSE to disable.}

\item{highlight}{A character vector of SNPs in your
dataset to highlight. These SNPs should all be in your
dataset.}
\item{highlight}{A character vector of SNPs in your dataset to highlight.
These SNPs should all be in your dataset.}

\item{...}{Arguments passed on to other plot/points
functions}
\item{...}{Arguments passed on to other plot/points functions}
}
\value{
A manhattan plot.
}
\description{
Creates a manhattan plot from PLINK assoc output (or any
data frame with chromosome, position, and p-value).
Creates a manhattan plot from PLINK assoc output (or any data frame with
chromosome, position, and p-value).
}
\examples{
manhattan(gwasResults)
Expand Down
7 changes: 3 additions & 4 deletions man/qq.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,15 @@
qq(pvector, ...)
}
\arguments{
\item{pvector}{A numeric vector of p-values.}
\item{pvector}{A numeric vector of p-values.}

\item{...}{Other arguments passed to \code{plot()}}
\item{...}{Other arguments passed to \code{plot()}}
}
\value{
A Q-Q plot.
}
\description{
Creates a quantile-quantile plot from p-values from a GWAS
study.
Creates a quantile-quantile plot from p-values from a GWAS study.
}
\examples{
qq(gwasResults$P)
Expand Down
4 changes: 2 additions & 2 deletions man/qqman.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
\alias{qqman-package}
\title{Create Q-Q and manhattan plots for GWAS data.}
\description{
A package for creating Q-Q and manhattan plots for GWAS
data. See the package vignette for details: \cr\cr
A package for creating Q-Q and manhattan plots for GWAS data. See the package
vignette for details: \cr\cr
\code{vignette("qqman")}
}
\author{
Expand Down

0 comments on commit 8be6fd9

Please sign in to comment.