add sample validation page for wetlab

qiita-spots · Sep 20, 2022 · cdba252 · cdba252
1 parent 30b6921
commit cdba252
Show file tree

Hide file tree

Showing 4 changed files with 106 additions and 1 deletion.
diff --git a/qiita_pet/handlers/admin_processing_job.py b/qiita_pet/handlers/admin_processing_job.py
@@ -13,6 +13,7 @@
 from qiita_core.util import execute_as_transaction
 
 from qiita_db.software import Software
+from qiita_db.study import Study
 
 from json import dumps
 
@@ -91,3 +92,40 @@ def get(self):
 
         # return the json in compact form to save transmit size
         self.write(dumps(results, separators=(',', ':')))
+
+
+class SampleValidation(AdminProcessingJobBaseClass):
+    @coroutine
+    @execute_as_transaction
+    def get(self):
+        self._check_access()
+
+        self.render("sample_validation.html", input=True)
+
+    @execute_as_transaction
+    def post(self):
+
+        # Get user-inputted qiita id and sample names
+        qid = self.get_argument("qid")
+        snames = self.get_argument("snames").split()
+
+        qsnames = list(Study(qid).sample_template)
+        for i, qsname in enumerate(qsnames):
+            if qsname.startswith(qid):
+                qsnames[i] = qsname.replace(f'{qid}.', "", 1)
+
+        blank = []
+        for name in snames:
+            if name.lower().startswith('blank'):
+                blank.append(name)
+                snames.remove(name)
+
+        # Validate user's sample names against qiita study
+        qsnames = set(qsnames)
+        snames = set(snames)
+        matching = qsnames.intersection(snames)
+        missing = qsnames.difference(snames)
+        extra = snames.difference(qsnames)
+
+        self.render("sample_validation.html", input=False, matching=matching,
+                    missing=missing, extra=extra, blank=blank)
diff --git a/qiita_pet/templates/sample_validation.html b/qiita_pet/templates/sample_validation.html
@@ -0,0 +1,65 @@
+{% extends sitebase.html %}
+{% block head %}
+<style>
+    .column {
+    float: left;
+    width: 25%;
+    }
+
+    .row:after {
+    content: "";
+    display: table;
+    clear: both;
+    }
+</style>
+{% end %}
+{% block content %}
+<h1>Sample Validation</h1><br>
+{% if input %}
+<form action="{% raw qiita_config.portal_dir %}/admin/sample_validation/" method="post" id="sample_validation_form"> 
+    <label for="qid">Qiita id:</label><br>
+    <input type="text" id="qid" name="qid"><br>
+    <label for="snames">Sample names:</label><br>
+    <textarea id="sname" name="snames"></textarea><br><br>
+    <input type="submit" value="Submit">
+</form>
+{% else %}
+<div class="row">
+    <div class="column">
+        <h2>Matching</h2>
+        <ul>
+            {% for sample in matching %}
+            <li>{{ sample }}</li>
+            {% end %}
+        </ul>
+    </div> 
+    <div class="column">
+        <h2>Missing</h2>
+        <ul>
+            {% for sample in missing %}
+            <li>{{ sample }}</li>
+            {% end %}
+        </ul>
+    </div>
+    <div class="column">
+        <h2>Blank</h2>
+        <ul>
+            {% for sample in blank %}
+            <li>{{ sample }}</li>
+            {% end %}
+        </ul>
+    </div>
+    <div class="column">
+        <h2>Extra</h2>
+        <ul>
+            {% for sample in extra %}
+            <li>{{ sample }}</li>
+            {% end %}
+        </ul>
+    </div>
+</div>
+<form action="{% raw qiita_config.portal_dir %}/admin/sample_validation/" method="get" id="return_to_sample_validation_form">
+    <input type="submit" value="Validate more samples">
+</form>
+{% end %}
+{% end %}
diff --git a/qiita_pet/templates/sitebase.html b/qiita_pet/templates/sitebase.html
@@ -383,6 +383,7 @@
                       <li><a href="{% raw qiita_config.portal_dir %}/admin/error/">View Errors</a></li>
                       <li><a href="{% raw qiita_config.portal_dir %}/admin/approval/">View Studies awaiting approval</a></li>
                       <li><a href="{% raw qiita_config.portal_dir %}/admin/portals/studies/">Edit study portal connections</a></li>
+                      <li><a href="{% raw qiita_config.portal_dir %}/admin/sample_validation/">Sample Validation</a></li>
                     {% end %}
                     <li><a href="{% raw qiita_config.portal_dir %}/admin/processing_jobs/">Processing Jobs</a></li>
                   {% else %}

diff --git a/qiita_pet/webserver.py b/qiita_pet/webserver.py
@@ -25,7 +25,7 @@
     ChangeForgotPasswordHandler, ForgotPasswordHandler, UserProfileHandler,
     UserMessagesHander, UserJobs)
 from qiita_pet.handlers.admin_processing_job import (
-    AdminProcessingJob, AJAXAdminProcessingJobListing)
+    AdminProcessingJob, AJAXAdminProcessingJobListing, SampleValidation)
 from qiita_pet.handlers.analysis_handlers import (
     ListAnalysesHandler, AnalysisSummaryAJAX, SelectedSamplesHandler,
     AnalysisDescriptionHandler, AnalysisGraphHandler, CreateAnalysisHandler,
@@ -133,6 +133,7 @@ def __init__(self):
             (r"/admin/artifact/", ArtifactAdminAJAX),
             (r"/admin/processing_jobs/", AdminProcessingJob),
             (r"/admin/processing_jobs/list", AJAXAdminProcessingJobListing),
+            (r"/admin/sample_validation/", SampleValidation),
             (r"/ebi_submission/(.*)", EBISubmitHandler),
             # Study handlers
             (r"/study/create/", StudyEditHandler),