Diff of /man/requireBrainarray.Rd [000000] .. [28aa3b]

Switch to side-by-side view

--- a
+++ b/man/requireBrainarray.Rd
@@ -0,0 +1,42 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/requireBrainarray.R
+\name{requireBrainarray}
+\alias{requireBrainarray}
+\title{Installs brainarray CDF and probe information packages}
+\usage{
+requireBrainarray(array_type, custom_cdf = "enst",
+  version = getLatestVersion())
+}
+\arguments{
+\item{array_type}{A character of length 1 giving the giving the name of the'
+array. (Preferably as returned by \code{affyio::read.celfile.header})}
+
+\item{custom_cdf}{A charcter giving the annotation type.}
+
+\item{version}{A character of length 1 giving the version to download.}
+}
+\value{
+Invisibly returns a list of the locations of the saved files.
+}
+\description{
+This package downloads, installs, and/or loads the brainarray CDF and probe
+enviroments from the Brainarray website.
+}
+\examples{
+tmp.path <- requireBrainarray("hgu133a", custom_cdf = "enst",
+                              version = "18.0.0")
+print(tmp.path)
+tmp.path2 <- requireBrainarray("hgu133a", custom_cdf = "enst")
+print(tmp.path2)
+}
+\author{
+Steffen Falgreen,
+  Anders Ellern Bilgrau
+}
+\references{
+See \url{http://brainarray.mbni.med.umich.edu}.
+}
+\seealso{
+\code{\link{tempdir}}, \code{\link{install.packages}}
+}
+