<?php

$title = 'Help';
require_once 'header.inc.php';
?>
<h2><A NAME="start"></A><strong>DASR User Guide</strong>
</h2>
<table width="486" border="0" cellpadding="0" cellspacing="0" bordercolor="#999999" bgcolor="#FFFFFF">
  <tr>
    <td colspan="2" bgcolor="#99FF99"><div align="center"><strong>Table of Contents</strong></div></td>
  </tr>
  <tr>
    <td width="240" bgcolor="#FFFF99">
      <div align="left">
        <ul>
          <li><a href="DASR_help/DASR_schema_tables.php" target="_blank">Database structure</a></li>
        </ul>
    </div></td>
    <td width="246" bgcolor="#FFFF99"><ul>
      <li><a href="#ucsc">View bed files on UCSC </a></li>
    </ul></td>
  </tr>
  <tr>
    <td bgcolor="#FFFF99">
      <div align="left">
        <ul>
          <li><a href="#account">User account/experiment set-up</a></li>
        </ul>
    </div></td>
    <td bgcolor="#FFFF99"><ul>
      <li><a href="#compare">Compare bed files</a></li>
    </ul></td>
  </tr>
  <tr>
    <td bgcolor="#FFFF99">
      <div align="left">
        <ul>
          <li><a href="#upload">Upload bed files</a></li>
        </ul>
    </div></td>
    <td bgcolor="#FFFF99"><ul>
      <li><a href="#extract">Extract bed files</a></li>
    </ul></td>
  </tr>
  <tr>
    <td bgcolor="#FFFF99">
      <div align="left">
        <ul>
          <li><a href="#delete">Delete bed files</a></li>
        </ul>
    </div></td>
    <td bgcolor="#FFFF99"><ul>
      <li><a href="#split">Split bed files</a></li>
    </ul></td>
  </tr>
  <tr>
    <td bgcolor="#FFFF99">
      <div align="left">
        <ul>
          <li><a href="#annotate">Annotate bed files</a></li>
        </ul>
    </div></td>
    <td bgcolor="#FFFF99"><ul>
      <li><a href="#download">Download bed files</a></li>
    </ul></td>
  </tr>
  <tr>
    <td bgcolor="#FFFF99">
      <div align="left">
        <ul>
          <li><a href="#admin">Administrator priviledges</a></li>
        </ul>
    </div></td>
    <td bgcolor="#FFFF99"><ul>
      <li><a href="#count">Count bed files</a></li>
    </ul></td>
  </tr>
  <tr>
    <td bgcolor="#FFFF99">
      <div align="left">
        <ul>
          <li><a href="#search">View and find  bed files</a></li>
        </ul>
    </div></td>
    <td bgcolor="#FFFF99"><ul>
      <li><a href="#preview">Preview bed files</a></li>
    </ul></td>
  </tr>
</table>
<p><strong>Useful Documentations:</strong>
<ul>
  <li><a href="BEDTools-User-Manual.v4.pdf" target="_blank">BEDTOOLS 4 User Manual</a></li>
  <li><a href="BEDfile_specification.pdf" target="_blank">BED file format specifications</a></li>
</ul>
<p><strong>Questions? Comments? Contact Us <a href="feedback.php" target="_blank">here</a></strong><BR>

<hr />
<p><A NAME="account"></A><span class="style1">Account and experiment set-up:</span></p>
<p>New users can register for a new account on DASR by clicking on the &quot;New User? Register here&quot; link on the <a href="http://128.197.87.29/DASR_2011/index.php" target="_blank">DASR login page</a>. Here, the  user will be asked to enter a username, password and a valid email. Once the user has been approved by the administrator, a confirmation email will be sent out with a link to DASR where the user can now enjoy full access to the database. </p>
<p>One of the unique features of DASR is that it allows the user to set up a personalized &quot;Experiment&quot; sessions that can be populated with bed files of choice. To do so, click on the Create Experiment button and provide the experiment name etc. </p>
<p><a href="#start">Back to top</a></p>
<hr />

<p>  <A NAME="upload"></A>
  <span class="style1">Upload bed files:</span></p>
<p><em>Uploading user-supplied bed files</em>: The upload button <img src="upload.jpeg" alt="upload" width="24" height="23" /> enables bed file to be uploaded to the database by browsing or by simply dragging the file to be uploaded to the screen. The file size cutoff is 500MB, where files smaller than 500MB are stored in the database that allows it to be queried, and files larger than 500MB are saved in a non-queriable format. Once the bed file is uploaded, the file will be visible on the main dashboard. </p>
<p><em>Uploading bed files from the &quot;Reference files library&quot;: </em>As the name implies, the reference file library is a library containing standard, frequently-referred-to bed files. The reference files are managed by the administrator; therefore, regular users do not have access to make changes to these files. The user can, however, upload the reference files to his or her personal Experiment session for analysis. This can be done by clicking on reference file pull-down menu located at the bottom of the experiment page, and selecting the reference file to be uploaded. </p>
<p><a href="#start">Back to top</a><br />
<hr />
  <p><A NAME="delete"></A><span class="style1">Delete bed files:</span></p>
  <p>Bed  files can be delected. Please note that deletion is permanent and irreversible. To delete bed fiels, select the checkbox next to the bed file to be deleted and click on the delete button <img src="delete.jpeg" alt="delete" width="17" height="15" />. The delected file will appear as a strickthrough format. To remove the bed file from view, simply reload the page. </p>
  <p><a href="#start">Back to top</a><BR> <hr />
    <p><A NAME="annotate"></A><span class="style1">Annotate bed files:</span></p>
    <p>The edit functions allows user to assign descriptors to bed files. To do so, check the checkbox(es) next to the bed file(s) to be annotated and click on the &quot;edit&quot; button <img src="edit.jpeg" alt="edit" width="19" height="17" />. The fields: &quot;name&quot;, &quot;genome&quot;, &quot;method&quot;, &quot;header&quot; and &quot;description&quot; will become text fields that accept user inputs. Modify the fields as needed and when done, click on the &quot;done editing button&quot; and the new descriptors will be saved to the database. </p>
    <p><a href="#start">Back to top</a><BR><hr />
        <p><A NAME="admin"></A> <span class="style1">Administrator priviledges:</span></p>
        <p>The administrator has privilegde to upload, delete, annotate reference bed files. This privilege is not availabel to regular uses -- to whom the reference files are immutable. To become an administrator of the database, please contact the DASR developers for your account to be approved. </p>
        <p><a href="#start">Back to top</a><BR><hr />
            <p><A NAME="search"></A><span class="style1">View and search bed files:</span></p>
            <p>The administrator has priviledge to view and search experiments and bed files generated by all users. On the main <a href="http://128.197.87.29/DASR_2011/index.php">index page</a> of the administrator, all experiments are displayed. Each experiment is hyperlinked to the experiment page containing individual bed files. To view all the bed files contained in the database, click on the &quot;view all bed file&quot; link which will take the administrator to a page where all the bed files are listed. Here, the administrator has access to make modification or delete the bed files listed. The bed files are also searcheable by the bed file name. </p>
            <p><a href="#start">Back to top</a><BR>
            </p>
            <hr />
            <p><A NAME="ucsc"></A><span class="style1">Visualize bed files on the UCSC Genome Browser:</span></p>
            <p>The DASR database is linked to the UCSC browser, allowing users to visualize the bed files stored in the database on the UCSC genome browser directly. To do so, first select the bed file(s) to be visualized by checking the checkbox, then click on the UCSC browser link <img src="ucsc.jpeg" alt="UCSC" width="14" height="14" />. The bed file will be uploaded to the UCSC browser automatically. If error occurs, please check for common errors in the bed file format, eg. chromosome start larger than end; chromosome end larger than the chromosome length. </p>
            <p><a href="#start">Back to top</a><BR><hr />
                          <p><A NAME="compare"></A> <span class="style1">Compare bed files:</span></p>
                          <p>DASR integrates the BEDTOOLS package to search for overlaps between two bed files. To perform the DASR Compare function, exactly two bed files must be selected. Once two bed files have been specified by clicking on the checkboxes, click on the Compare button <img src="DASR/compare.png" alt="compare" width="20" height="17" />. A pop-up window will appear prompting for the number of base pair overlap. The DASR compare function generates two output files: 1) Side_by_side_comparison output: this is the raw output generated from the Bedtools where the last column indicates the number of base pair overlap (see BedTools manual) 2) Regions_of_overlap output: this output only shows the regions that are overlapping in the two input bed files being compared. This output is compatible with UCSC browser and can be <a href="#download">downloaded</a> for visualizations. Upon the completion of the comparison, the output files will be automatically uploaded to the dashboard, where additional functionalities can be applied. In addition to file outputs, statistical details of the overlap are displayed in graphs. These graphs can be accessed by clicking on the hyperlinked file names of the output. Figure 1 of the graph output shows the number of reads overlap while figure 2 shows the overlap per reads by chromosome. </p>
                                                <p> It should be noted that the BedTools comparison reports only the specific over lapping regions between samples.  For cases where there may be full or partial overlap between sequence reads, only the regions of overlap are reported in the BedTools result.  As depicted in the figure below; scenario 1 results in no overlap, scenario 2 reports the over lapping region for full overlap, and scenario 3 reports the over lapping region for partial overlap.</p>
                                                <h1 align="center"><img src="BedTools_Output_Diagram.gif" alt="BedTools_Output_Diagram" width="700" height="400" /></h1>

                                                  <p><a href="#start">Back to top</a></p>
<hr />

                              <p><A NAME="extract"></A> <span class="style1">Extracting bed files:</span></p>
                              <p>Bed files can be queried and extracted using the Extract function. Select the bed files to be extracted, and click on the Extract button <img src="extract" alt="extract" width="20" height="16" />. A pop-up window will appear where the user can input the regions to be extracted (chromosome, start and end). The user also has the option of extracting the bed file based on RGB value. The extracted file is automatically uploaded to the dashboard and stored in the database. </p>
                              <p><a href="#start">Back to top</a></p>
                              <hr />

                              <p><A NAME="split"></A> <span class="style1">Splitting bed files:</span></p>
                              <p>An extension of the Extract function is the is splitting large bed files according to chromosomes. For example, for a bed file that contains reads from chromosome 1 to 20, the Extract function can be repeatedly utilized to separate the file into 20 individual files for each chromosome. </p>
                              <p><a href="#start">Back to top</a><BR>
                              <hr />
                                                              <p><A NAME="download"></A><span class="style1">Downloading bed files:</span></p>
                                                              <p>All bed files displayed on the dashboard are available for download. Select the bed file to be downloaded and click on the download button <img src="download.jpeg" alt="download" width="21" height="20" />. A number of file extentions: csv, xls, txt or custom specified file extenstion are available. </p>
                                                              <p><a href="#start">Back to top</a><BR>
                                                              <hr />
                                                                  <p><A NAME="count"></A><span class="style1">Count bed files:</span></p>
                                                                  <p>The count function provides statistical information on each bed file, specifically, it counts the number of individual reads in each bed file by chromosome and display the counts as values and pie chart. To access the count feature, click on the hyperlinked bed file names on the dashboard. </p>
                                                                  <p><a href="#start">Back to top</a><BR>
                                                                  <hr />

                                                                      <p><A NAME="preview"></A><span class="style1">Preview bed files:</span></p>
                                                                      <p>Bed files can be viewed directly on the browser without having to download them. To preview bed files, simply click on the hyperlinked bed file names on the dashboard. </p>
                                                                      <p><a href="#start">Back to top</a><BR><br />


</p>
<?php
require_once 'footer.inc.php';
?>
