% % NOTE -- ONLY EDIT beadarray.rnw!!! % beadarray.tex file will get overwritten. % %\VignetteIndexEntry{beadarray Vignette} %\VignetteDepends{} %\VignetteKeywords{beadarray expression Analysis} %\VignettePackage{beadarray} \documentclass{article} \usepackage{hyperref} \usepackage{Sweave} \textwidth=6.2in \textheight=8.5in %\parskip=.3cm \oddsidemargin=.1in \evensidemargin=.1in \headheight=-.3in \newcommand{\Rfunction}[1]{{\texttt{#1}}} \newcommand{\Robject}[1]{{\texttt{#1}}} \newcommand{\Rpackage}[1]{{\textsf{#1}}} \newcommand{\Rmethod}[1]{{\texttt{#1}}} \newcommand{\Rfunarg}[1]{{\texttt{#1}}} \newcommand{\Rclass}[1]{{\textit{#1}}} \newcommand{\classdef}[1]{ {\em #1} } \begin{document} \title{\Rpackage{beadarray}: R classes and methods for Illumina bead-based data} \author{Mark Dunning and Matt Ritchie} \maketitle \section*{Introduction} \Rpackage{beadarray} is a Bioconductor package for the analysis of Illumina data. The main feature of the package is its ability to process raw data (text files and TIFFs) from BeadScan and store this information in convenient R classes. Access to this \emph{bead-level data} offers users' the choice between different image processing and background correction methods and allows for detailed quality assessments to be carried out for each array. The summarised intensities (\emph{bead-summary data}) output by Illumina's BeadStudio software can also be imported using the \Rpackage{beadarray} package. The documentation for this package is split into separate user guides: one for bead-level data, a second for bead-summary data, and a third which provides details and examples of using the BASH (\textbf{b}ead\textbf{a}rray \textbf{S}ubversion of \textbf{H}arshlight) method for detecting spatial artefacts. These documents may be accessed using the following commands: <>= library(beadarray) beadarrayUsersGuide(topic="beadlevel") beadarrayUsersGuide(topic="beadsummary") beadarrayUsersGuide(topic="BASH") @ \section{Citing \Rpackage{beadarray}} \begin{flushleft} If you use \Rpackage{beadarray} for the analysis or pre-processing of Illumina data please cite:\newline Dunning MJ, Smith ML, Ritchie ME, Tavar\'e S. \emph{beadarray: R classes and methods for Illumina bead-based data}. Bioinformatics, 2007 Aug 15; 23(16):2183-4.\newline For recommendations on the low-level analysis of bead-level data, or if you make use of the spike-in data set available from\newline {\tt http://www.compbio.group.cam.ac.uk/Resources/spike/}\newline please cite:\newline Dunning MJ, Barbosa-Morais NL, Lynch AG, Tavar\'e S, Ritchie ME. \emph{Statistical issues in the analysis of Illumina data}. BMC Bioinformatics. 2008 Feb 6;9(1):85.\newline For a validation of the VST method (implemented in the \Rpackage{lumi} package) on the spike-in data set and a comparison of the results obtained from a full bead-level analysis, see\newline Dunning MJ, Ritchie ME, Barbosa-Morais NL, Tavar\'e S, Lynch AG. \emph{Spike-in validation of an Illumina-specific variance-stabilizing transformation}. BMC Research Notes, 2008, 1:18.\newline If you use BASH to detect spatial artefacts, please cite\newline Cairns JM, Dunning MJ, Ritchie ME, Russell R, Lynch AG. \emph{BASH: A tool for managing BeadArray spatial artefacts}. (submitted).\newline If you use the probe reannotation for Illumina expression arrays (used in the current Bioconductor annotation packages named \Rpackage{illuminaXXXXX.db}) please cite\newline Barbosa-Morais NL, Dunning MJ, Ritchie ME, Lynch AG, Tavar\'e S. \emph{Reannotation of Illumina BeadArray probes improves the interpretation of gene expression data}. (in preparation).\newline Supplementary tables and supporting information for this annotation are available at\newline {\tt http://www.compbio.group.cam.ac.uk/Resources/Annotation/}. \end{flushleft} \section{Asking for help on \Rpackage{beadarray}} Wherever possible, please send all queries about \Rpackage{beadarray} to the Bioconductor mailing list at {\tt bioconductor@stat.math.ethz.ch}. This will help maintain a searchable archive of questions and responses. When posting to the list, please include the commands you used along with the version of \Rpackage{beadarray} and {\tt R} you are working with. Version information can be obtained by running the following command: <>= sessionInfo() @ \end{document}