diff test-data/README.html @ 1:acaa8e8a0b88 draft default tip

Uploaded test-data & added tool help
author chmaramis
date Mon, 30 Apr 2018 04:47:52 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test-data/README.html	Mon Apr 30 04:47:52 2018 -0400
@@ -0,0 +1,93 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <!--<link rel="stylesheet" href="style/base.css" type="text/css" />-->
+</head>
+<body style="margin-left: 1cm">
+<div class="jumbotron">
+<div class="container">
+<h3>Test Data Name Conventions</h3>
+<p>Concerning the naming of the execution parameters, input and output files, the following convention applies: </p>
+<ul>
+<li class="container">The name starts with the tool specifier; see Tool Specifiers Table below.</li>
+<li class="container">The clonotype definition specifier follows, if needed; see Clonotype Definition Specifiers Table below.</li>
+<li class="container">The gene specifier (geneV or geneJ) follows, if needed.</li>
+<li class="container">The cell type specifier (BCR or TCR) follows.</li>
+<li class="container">The name ends with the file content specifier (input, output or parameters).</li>
+</ul>
+
+<p><i>Tool Specifiers Table</i></p>
+<table style="border-spacing: 10px 0px">
+<tr align="left">
+<th>Index</th>
+<th>Tool</th>
+<th>Specifier</th>
+</tr>
+<tr>
+<td>1</td>
+<td>Data Filtering</td>
+<td>data_filter</td>
+</tr>
+<tr>
+<td>2</td>
+<td>Clonotype Diversity &amp; Expression</td>
+<td>clono_compute</td>
+</tr>
+<tr>
+<td>3</td>
+<td>Gene Usage</td>
+<td>gene_usage</td>
+</tr>
+<tr>
+<td>4</td>
+<td>Public Clonotypes</td>
+<td>public_clonos</td>
+</tr>
+<tr>
+<td>5</td>
+<td>Exclusive Clonotypes</td>
+<td>exclusive_clonos</td>
+</tr>
+<tr>
+<td>6</td>
+<td>Gene Usage Comparison</td>
+<td>gene_compare</td>
+</tr>
+</table>
+
+<br>
+
+<p><i>Clonotype Definition Specifiers Table</i></p>
+<table style="border-spacing: 10px 0px">
+<tr align="left">
+<th>Index</th>
+<th>Clonotype Definition</th>
+<th>Specifier</th>
+</tr>
+<tr>
+<td>1</td>
+<td>CDR3</td>
+<td>def1</td>
+</tr>
+<tr>
+<td>2</td>
+<td>V+CDR3</td>
+<td>def2</td>
+</tr>
+<tr>
+<td>3</td>
+<td>J+CDR3</td>
+<td>def3</td>
+</tr>
+<tr>
+<td>4</td>
+<td>V+J+CDR3</td>
+<td>def4</td>
+</tr>
+<tr>
+<td>5</td>
+<td>V+D+J+CDR3</td>
+<td>def5</td>
+</tr>
+</table>