CIMAC-CIDC/cidc-schemas

View on GitHub
docs/docs/assays.cytof.cytof_analysis_template.html

Summary

Maintainability
Test Coverage

<!DOCTYPE html>
<html>
  <head>
    <title>CIDC Schemas</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
    <style>
      .bd-placeholder-img {
        font-size: 1.125rem;
        text-anchor: middle;
        -webkit-user-select: none;
        -moz-user-select: none;
        -ms-user-select: none;
        user-select: none;
      }

      @media (min-width: 768px) {
        .bd-placeholder-img-lg {
          font-size: 3.5rem;
        }
      }
    </style>
  </head>
  <body>
    <main role="main">
      

    
    <div class="container">
        <p>
            <a href="index.html">CIDC Documentation</a>
        </p>
        <h1>
            CyTOF analysis template
            
        </h1>
        <p>
            <b>Description:</b>  Cytometry by Time-Of-Flight (CyTOF) analysis submission.
        </p>
    </div>

    <div class="container">
        
            

    <div class="accordion" id="CyTOF_Analysis_accordion">
        <div class="card">
            <div class="card-header" id="CyTOF_Analysis">
                <h2 class="mb-0">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#CyTOF_Analysis_card" aria-expanded="false" aria-controls="CyTOF_Analysis_card">
                        Worksheet - CyTOF Analysis
                    </button>
                </h2>
            </div>
            <div id="CyTOF_Analysis_card" class="collapse" aria-labelledby="CyTOF_Analysis" data-parent="#CyTOF_Analysis_accordion">
                <div class="card-body">
                    
                        <div class="accordion" id="CyTOF_Analysis_preamble_accordion">
                            <div class="card">
                                <div class="card-header" id="CyTOF_Analysis_preamble">
                                    <h2 class="mb-0">
                                        <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#CyTOF_Analysis_preamble_card" aria-expanded="false" aria-controls="CyTOF_Analysis_preamble_card">
                                            Preamble Rows
                                        </button>
                                    </h2>
                                </div>
                                <div id="CyTOF_Analysis_preamble_card" class="collapse" aria-labelledby="CyTOF_Analysis_preamble" data-parent="#CyTOF_Analysis_preamble_accordion">
                                    <div class="card-body">
                                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="assay run id">
                assay run id
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            User defined unique identifier for this assay run. Not necessarily unique across batches.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="protocol identifier">
                protocol identifier
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Trial identifier used by lead organization, ie. Center for Experimental Therapeutics Program (CTEP) ID or Industry Sponsored ID.  This is usually a short identifier. Example: E4412.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="batch id">
                batch id
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            CyTOF batch identification number. Unique to every batch.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="astrolabe reports">
                astrolabe reports
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a ZIP file.
        
    </td>
    <td>
        
            <a href="files.zip.html">
                zip
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="astrolabe analysis">
                astrolabe analysis
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a ZIP file.
        
    </td>
    <td>
        
            <a href="files.zip.html">
                zip
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
            
        
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="control files package">
                control files package
            </span>
            
        
    </td>
    <td width=55%>
        
            Information about a ZIP file.
        
    </td>
    <td>
        
            <a href="files.zip.html">
                zip
            </a>
        
    </td>
</tr>
                
            
        
        
            
        
            
        
            
        
            
        
            
        
            
        
    </table>
                                    </div>
                                </div>
                            </div>
                        </div>
                    
                    
                        <div class="accordion" id="CyTOF_Analysis_body_accordion">
                            <div class="card">
                                <div class="card-header" id="CyTOF_Analysis_body">
                                    <h2 class="mb-0">
                                        <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#CyTOF_Analysis_body_card" aria-expanded="false" aria-controls="CyTOF_Analysis_body_card">
                                            Data Columns
                                        </button>
                                    </h2>
                                </div>
                                <div id="CyTOF_Analysis_body_card" class="collapse" aria-labelledby="CyTOF_Analysis_body" data-parent="#CyTOF_Analysis_body_accordion">
                                    <div class="card-body">
                                        
                                            <h5 class="text-muted">Astrolabe Runs</h4>
                                            
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="cimac id">
                cimac id
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Specimen identifier assigned by the CIMAC-CIDC Network. Formatted as CTTTPPPSS.AA for trial code TTT, participant PPP, sample SS, and aliquot AA.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
                as regex <br> <code>^C[A-Z0-9]{3}[A-Z0-9]{3}[A-Z0-9]{2}.[0-9]{2}$</code>
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="fcs file">
                fcs file
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a FCS file.
        
    </td>
    <td>
        
            <a href="files.fcs.html">
                fcs
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="assignment">
                assignment
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a comma separated file.
        
    </td>
    <td>
        
            <a href="files.csv.html">
                csv
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="compartment">
                compartment
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a comma separated file.
        
    </td>
    <td>
        
            <a href="files.csv.html">
                csv
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="profiling">
                profiling
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a comma separated file.
        
    </td>
    <td>
        
            <a href="files.csv.html">
                csv
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="cell counts assignment">
                cell counts assignment
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a comma separated file.
        
    </td>
    <td>
        
            <a href="files.csv.html">
                csv
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="cell counts compartment">
                cell counts compartment
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a comma separated file.
        
    </td>
    <td>
        
            <a href="files.csv.html">
                csv
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="cell counts profiling">
                cell counts profiling
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about a comma separated file.
        
    </td>
    <td>
        
            <a href="files.csv.html">
                csv
            </a>
        
    </td>
</tr>
                
            
        
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
    </table>
                                        
                                    </div>
                                </div>
                            </div>
                        </div>
                    
                </div>
            </div>
        </div>
    </div>
        
            

    <div class="accordion" id="Excluded_Samples_accordion">
        <div class="card">
            <div class="card-header" id="Excluded_Samples">
                <h2 class="mb-0">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#Excluded_Samples_card" aria-expanded="false" aria-controls="Excluded_Samples_card">
                        Worksheet - Excluded Samples
                    </button>
                </h2>
            </div>
            <div id="Excluded_Samples_card" class="collapse" aria-labelledby="Excluded_Samples" data-parent="#Excluded_Samples_accordion">
                <div class="card-body">
                    
                    
                        <div class="accordion" id="Excluded_Samples_body_accordion">
                            <div class="card">
                                <div class="card-header" id="Excluded_Samples_body">
                                    <h2 class="mb-0">
                                        <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#Excluded_Samples_body_card" aria-expanded="false" aria-controls="Excluded_Samples_body_card">
                                            Data Columns
                                        </button>
                                    </h2>
                                </div>
                                <div id="Excluded_Samples_body_card" class="collapse" aria-labelledby="Excluded_Samples_body" data-parent="#Excluded_Samples_body_accordion">
                                    <div class="card-body">
                                        
                                            <h5 class="text-muted">Samples Excluded From Analysis</h4>
                                            
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="cimac id">
                cimac id
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Specimen identifier assigned by the CIMAC-CIDC Network. Formatted as CTTTPPPSS.AA for trial code TTT, participant PPP, sample SS, and aliquot AA.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
                as regex <br> <code>^C[A-Z0-9]{3}[A-Z0-9]{3}[A-Z0-9]{2}.[0-9]{2}$</code>
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="reason">
                reason
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            A comment describing why this sample is missing from the pipeline output.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
        
            
                
            
        
            
                
            
        
        
            
        
            
        
    </table>
                                        
                                    </div>
                                </div>
                            </div>
                        </div>
                    
                </div>
            </div>
        </div>
    </div>
        
    </div>


    </main>
    <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
  </body>
</html>