Department of Bioinformatics and Computational Biology

RATBuilder:Overview

From MD Anderson Bioinformatics
Jump to: navigation, search

RATb : The Report and Analysis Template Builder

Logo
RATb
Overview
Description The Report and Analysis Template Builder (RATb) uses XML and R to create reusable, structured Sweave files for the statistical and bioinformatic analysis of high-throughput 'omics' datasets.
URL http://bioinformatics.mdanderson.org/RATb/TemplateBuilder/startTemplate.cgi
Development Information
Current Version 2.1


Last Updated 2009-03-12


Help and Support
Contact Kevin R. Coombes


The Report and Analysis Template Builder (RATb) uses XML and R to create reusable, structured Sweave files for the statistical and bioinformatic analysis of high-throughput 'omics' datasets.

Contents


Documentation

Using RATb

Use RATb http://bioinformatics.mdanderson.org/RATb/TemplateBuilder/startTemplate.cgi

A Template XML Document Type Description (DTD) file

<?xml version="1.0"?>
<!-- $Author: KRCoombes $ $Date: 2009-02-04 10:59:59 -0600 (Wed, 04 Feb 2009) $
$URL: http://dqsbcb03/svn/krc-perlcgi-server-software-01/trunk/RATb/RATb/templates-dtd.txt $
-->
<!ELEMENT Templates    (Template+)>
<!ELEMENT Template     (FileName,Description,Parameters)>
   <!ATTLIST Template Type (header|trailer|qc|analysis) #REQUIRED>
<!ELEMENT FileName     (#PCDATA)>
<!ELEMENT Description  (#PCDATA)>
<!ELEMENT Parameters   (Item*)>
<!ELEMENT Item         (#PCDATA)>
   <!ATTLIST Item Name    CDATA #REQUIRED>
   <!ATTLIST Item Default CDATA "">
   <!ATTLIST Item Long    (yes|no) "no">

A Sample XML Template File

<?xml version="1.0"?>
<!-- $Author: KRCoombes $ $Date: 2009-02-04 10:59:59 -0600 (Wed, 04 Feb 2009)
$ $URL: http://dqsbcb03/svn/krc-perlcgi-server-software-01/trunk/RATb/RATb/minimalHead.xml $ -->

<Template Type="header">
    <FileName>Templates/minimalHead.Rnw</FileName>
    <Description>This Rnw file contains a minimal LaTeX header. This includes the
                 \documentclass and \begin{document} commands,and almost nothing else.
                 You really do not want to use this header; it only exists to test some
                 of the capabilities of the Report Template Builder.
    </Description>
    <Parameters>
        <Item Name="TITLE">The title of the report.</Item>
        <Item Name="AUTHOR">The author(s) of the report.</Item>
        <Item Name="DATE">The date the report was prepared.</Item>
    </Parameters>
</Template>

A Sample Sweave (Rnw) Template Component file

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% The definitive version of this file lives in a subversion
% repository at 
% $URL: http://dqsbcb03/svn/krc-perlcgi-server-software-01/trunk/RATb/RATb/minimalHead.Rnw $. 
% The most recent version was produced by $Author: krcoombes $ 
% on $Date: 2009-03-05 14:28:53 -0600 (Thu, 05 Mar 2009) $. 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\documentclass{article}
\title{TITLE}
\author{AUTHOR}
\date{DATE}

\begin{document}
\maketitle


Auxuliary material

Some templates refer to auxiliary data or information; those are stored at ./Auxiliary


Notes

The XML component is used to describe the replacable parameters in a template file; the data in these files drives the construction of the RATb web site. The XML DTD file is really quite simple.

It defines the 'Templates' document type to be a list of one or more 'Template' objects. Each 'Template' consists of:

  • A 'FileName', which is the location of the actual source of the template,
  • A 'Description', which is a short paragraph explaining the purpose of the template
  • A set of 'Parameters'.
In turn, the 'Parameters' form a list of 'Item' objects. The 'Name' of an 'Item' is the name of the parameter in the template file. The contents of an 'Item' describes the semantics/interpretation of that parameter. Optionally, a parameter 'Item' can have a 'Default' value, and a yes/no indicator of whether it is 'Long' (and so needs an entire text area in a form) or not (and so can fit into a smaller text field).

The actual template files are prepared as Sweave files. Sweave is a tool that combines the R statistical programming environment with the LaTeX typesetting system. This combination provides a powerful tool for conducting reproducible research.

Template files should be categorized (in the 'Type' attribute of the XML 'Template' entry) as one of four types: 'header', 'trailer', 'qc', or 'analysis'. (In our templates, preprocessing steps are included under 'qc'.) The types are used to organize the layout on the web site. A complete filled-in template file consists of one header, one processor that is either 'qc' or 'analysis', and one 'trailer'. Thus, most of the actual analysis templates are constructed without LaTex preambles or \begin{document} or \end{document} commands.

If you would like to contribute a template to the RATb project, please contact Kevin Coombes at the MD Anderson Cancer Center.

Support

For Frequently Asked Questions, Bug Reports, and other concerns, please visit the forum at [[ | this link]]

Contact Us

If you have any questions regarding RATb, please contact Kevin Coombes at the MD Anderson Cancer Center