CIMAC-CIDC/cidc-schemas

View on GitHub
docs/docs/assays.olink.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>
            Olink Assay
            
        </h1>
        <p>
            <b>Description:</b>  High-throughput multiplexed assays for protein biomarker discovery.
        </p>
    </div>

    <div class="container">
        <div class="accordion" id="assay_accordion">
            
                <div class="card">
                    <div class="card-header" id="assay_metadata">
                        <h2 class="mb-0">
                            <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#assay_metadata_card" aria-expanded="false" aria-controls="assay_metadata_card">
                                Assay Metadata
                            </button>
                        </h2>
                    </div>
                    <div id="assay_metadata_card" class="collapse" aria-labelledby="assay_metadata" data-parent="#assay_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="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 colspan=3 class="container">
        <div class="accordion" id="batches_accordion">
            <div class="card">
                <div class="card-header" id="batches">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#batches_card" aria-expanded="false" aria-controls="batches_card">
                        batches
                    </button>
                    
                        <sup><mark>required</mark></sup>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    array
                                
                            &gt;
                        </div>
                </div>
                <div id="batches_card" class="collapse" aria-labelledby="batches">
                    <div class="card-body">
                        
                            
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="assay_creator">
                assay_creator
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Indicates what site is filling out the assay.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
                <ul>
                    
                        <li>"DFCI"</li>
                    
                        <li>"Mount Sinai"</li>
                    
                        <li>"Stanford"</li>
                    
                        <li>"MD Anderson"</li>
                    
                        <li>"Adaptive"</li>
                    
                        <li>"Broad"</li>
                    
                </ul>
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
        
            
            
            
        
            
            
            
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="batch_id">
                batch_id
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            A unique identifier for this Olink upload
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="panel">
                panel
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Panel used for the assay.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
        
            
                
            
        
            
        
            
        
            
                
                    <tr>
    <td>
        
            <span id="assay_panel_lot">
                assay_panel_lot
            </span>
            
        
    </td>
    <td width=55%>
        
            Lot number of the assay panel.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
            
        
            
        
            
                
            
        
        
            
        
            
        
            
        
            
        
            
        
            
                <tr>
    <td colspan=3 class="container">
        <div class="accordion" id="combined_accordion">
            <div class="card">
                <div class="card-header" id="combined">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#combined_card" aria-expanded="false" aria-controls="combined_card">
                        combined
                    </button>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    object
                                
                            &gt;
                        </div>
                </div>
                <div id="combined_card" class="collapse" aria-labelledby="combined">
                    <div class="card-body">
                        
                            Batch-level combined NPX file.
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="npx_file">
                npx_file
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about an NPX file.
        
    </td>
    <td>
        
            <a href="files.npx.html">
                npx
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="npx_manager_version">
                npx_manager_version
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Version of NPX manager used for the analysis.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
        
            
                
            
        
            
        
            
                
            
        
        
            
        
            
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
            
                <tr>
    <td colspan=3 class="container">
        <div class="accordion" id="study_accordion">
            <div class="card">
                <div class="card-header" id="study">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#study_card" aria-expanded="false" aria-controls="study_card">
                        study
                    </button>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    object
                                
                            &gt;
                        </div>
                </div>
                <div id="study_card" class="collapse" aria-labelledby="study">
                    <div class="card-body">
                        
                            Study-level combined NPX file.
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="npx_file">
                npx_file
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about an NPX file.
        
    </td>
    <td>
        
            <a href="files.npx.html">
                npx
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="npx_manager_version">
                npx_manager_version
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Version of NPX manager used for the analysis.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
        
            
                
            
        
            
        
            
                
            
        
        
            
        
            
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
            
        
    </table>
                        </div>
                    </div>
                </div>
            
            
                <div class="card">
                    <div class="card-header" id="assay_data">
                        <h2 class="mb-0">
                            <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#assay_data_card" aria-expanded="false" aria-controls="assay_data_card">
                                Assay Data
                            </button>
                        </h2>
                    </div>
                    <div id="assay_data_card" class="collapse" aria-labelledby="assay_data" data-parent="#assay_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 colspan=3 class="container">
        <div class="accordion" id="batches_accordion">
            <div class="card">
                <div class="card-header" id="batches">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#batches_card" aria-expanded="false" aria-controls="batches_card">
                        batches
                    </button>
                    
                        <sup><mark>required</mark></sup>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    array
                                
                            &gt;
                        </div>
                </div>
                <div id="batches_card" class="collapse" aria-labelledby="batches">
                    <div class="card-body">
                        
                            
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
        
            
            
            
        
            
            
            
        
        
            
        
            
        
            
        
        
            
                <tr>
    <td colspan=3 class="container">
        <div class="accordion" id="records_accordion">
            <div class="card">
                <div class="card-header" id="records">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#records_card" aria-expanded="false" aria-controls="records_card">
                        records
                    </button>
                    
                        <sup><mark>required</mark></sup>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    array
                                
                            &gt;
                        </div>
                </div>
                <div id="records_card" class="collapse" aria-labelledby="records">
                    <div class="card-body">
                        
                            A single data record from Olink assay.
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
        
            
            
            
        
            
            
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="npx_manager_version">
                npx_manager_version
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Version of NPX manager used for the analysis.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="number_of_samples">
                number_of_samples
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Number of samples analyzed in the assay.
        
    </td>
    <td>
        
            &lt; 
                
        number
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
        
            
        
            
        
            
        
            
                
                    <tr>
    <td>
        
            <span id="baseline_correction">
                baseline_correction
            </span>
            
        
    </td>
    <td width=55%>
        
            Method used for baseline correction.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="chip_barcode">
                chip_barcode
            </span>
            
        
    </td>
    <td width=55%>
        
            Chip barcode number.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="fludigm_application_build">
                fludigm_application_build
            </span>
            
        
    </td>
    <td width=55%>
        
            Build of the Fluidgm application used.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="fludigm_application_version">
                fludigm_application_version
            </span>
            
        
    </td>
    <td width=55%>
        
            Version of the Fluidgm application used.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="instrument">
                instrument
            </span>
            
        
    </td>
    <td width=55%>
        
            Instrument used for the Olink assay.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
            
        
            
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="number_of_samples_failed">
                number_of_samples_failed
            </span>
            
        
    </td>
    <td width=55%>
        
            Number of samples failed in the assay.
        
    </td>
    <td>
        
            &lt; 
                
        number
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="passive_reference">
                passive_reference
            </span>
            
        
    </td>
    <td width=55%>
        
            Passive Reference.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="probe_type">
                probe_type
            </span>
            
        
    </td>
    <td width=55%>
        
            Probe Type.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="quality_threshold">
                quality_threshold
            </span>
            
        
    </td>
    <td width=55%>
        
            Threshold used for quality cutoff.
        
    </td>
    <td>
        
            &lt; 
                
        number
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="run_date">
                run_date
            </span>
            
        
    </td>
    <td width=55%>
        
            Date when the Olink assay was run.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

     :  date
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="run_time">
                run_time
            </span>
            
        
    </td>
    <td width=55%>
        
            Time when the Olink assay was run.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

     :  time
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
        
            
                <tr>
    <td colspan=3 class="container">
        <div class="accordion" id="files_accordion">
            <div class="card">
                <div class="card-header" id="files">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#files_card" aria-expanded="false" aria-controls="files_card">
                        files
                    </button>
                    
                        <sup><mark>required</mark></sup>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    object
                                
                            &gt;
                        </div>
                </div>
                <div id="files_card" class="collapse" aria-labelledby="files">
                    <div class="card-body">
                        
                            Olink assay input files.
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="assay_npx">
                assay_npx
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about an NPX file.
        
    </td>
    <td>
        
            <a href="files.npx.html">
                npx
            </a>
        
    </td>
</tr>
                
            
        
            
            
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="assay_raw_ct">
                assay_raw_ct
            </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>
    </td>
</tr>
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
            
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
    </table>
                        </div>
                    </div>
                </div>
            
            
            

            
                <div class="card">
                    <div class="card-header" id="assay_uploads">
                        <h2 class="mb-0">
                            <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#assay_uploads_card" aria-expanded="false" aria-controls="assay_uploads_card">
                                Assay Uploads
                            </button>
                        </h2>
                    </div>
                    <div id="assay_uploads_card" class="collapse" aria-labelledby="assay_uploads" data-parent="#assay_accordion">
                        <div class="card-body">
                            <table class="table table-striped">
        <thead>
        <tr>
            <th>Entity</th>
            <th>Description</th>
        </tr>
        </thead>
        
            <tr>
                <td width=25%>
                    <a href='assays.olink.olink_template.html'>
                        Olink assay template
                    </a>
                </td>
                <td>
                    Olink proteomics submission.
                </td>
            </tr>
        
    </table>
                        </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>