Add fitting comparison for datasets

Author: helenst

weblab/datasets/tests/test_views.py

@@ -574,3 +574,96 @@ def test_nonexistent_dataset_redirects_anonymous_to_login(self, client, helpers,
     def test_nonexistent_dataset_generates_404_for_user(self, client, logged_in_user, helpers, recipe, url):
         response = client.get(url % 10000)
         assert response.status_code == 404
+
+
+@pytest.mark.django_db
+class TestDatasetCompareFittingResultsView:
+    def test_shows_fittings_related_to_dataset(self, client, fittingresult_version):
+        fit = fittingresult_version.fittingresult
+
+        # should not be included, as it uses a different dataset
+        recipes.fittingresult_version.make()
+
+        response = client.get('/datasets/%d/fittings' % fit.dataset.pk)
+
+        assert response.status_code == 200
+        assert response.context['comparisons'] == [(fit.model, [fit])]
+
+    def test_groups_by_model(self, client, helpers, public_dataset):
+        m1, m2 = recipes.model.make(_quantity=2)
+        m1v = helpers.add_cached_version(m1, visibility='public')
+        m2v = helpers.add_cached_version(m2, visibility='public')
+
+        # Create publicly visible fitting result versions
+        fit1_m1 = recipes.fittingresult_version.make(
+            fittingresult__dataset=public_dataset,
+            fittingresult__model=m1,
+            fittingresult__model_version=m1v,
+            fittingresult__fittingspec_version__visibility='public',
+            fittingresult__protocol_version__visibility='public',
+        ).fittingresult
+
+        fit2_m1 = recipes.fittingresult_version.make(
+            fittingresult__dataset=public_dataset,
+            fittingresult__model=m1,
+            fittingresult__model_version=m1v,
+            fittingresult__fittingspec_version__visibility='public',
+            fittingresult__protocol_version__visibility='public',
+        ).fittingresult
+
+        fit3_m2 = recipes.fittingresult_version.make(
+            fittingresult__dataset=public_dataset,
+            fittingresult__model=m2,
+            fittingresult__model_version=m2v,
+            fittingresult__fittingspec_version__visibility='public',
+            fittingresult__protocol_version__visibility='public',
+        ).fittingresult
+
+        response = client.get('/datasets/%d/fittings' % public_dataset.id)
+
+        assert response.status_code == 200
+        assert response.context['comparisons'] == [
+            (m1, [fit1_m1, fit2_m1]),
+            (m2, [fit3_m2]),
+        ]
+
+    def test_multiple_model_versions_for_dataset(self, client, helpers, public_dataset):
+        m1, m2 = recipes.model.make(_quantity=2)
+        m1v1 = helpers.add_cached_version(m1, visibility='public')
+        m1v2 = helpers.add_cached_version(m1, visibility='public')
+        m2v = helpers.add_cached_version(m2, visibility='public')
+
+        # Create publicly visible fitting result versions
+        fit1_m1v1 = recipes.fittingresult_version.make(
+            fittingresult__dataset=public_dataset,
+            fittingresult__model=m1,
+            fittingresult__model_version=m1v1,
+            fittingresult__fittingspec_version__visibility='public',
+            fittingresult__protocol_version__visibility='public',
+        ).fittingresult
+
+        fit2_m1v2 = recipes.fittingresult_version.make(
+            fittingresult__dataset=public_dataset,
+            fittingresult__model=m1,
+            fittingresult__model_version=m1v2,
+            fittingresult__fittingspec_version__visibility='public',
+            fittingresult__protocol_version__visibility='public',
+        ).fittingresult
+
+        fit3_m2v = recipes.fittingresult_version.make(
+            fittingresult__dataset=public_dataset,
+            fittingresult__model=m2,
+            fittingresult__model_version=m2v,
+            fittingresult__fittingspec_version__visibility='public',
+            fittingresult__protocol_version__visibility='public',
+        ).fittingresult
+
+        response = client.get(
+            '/datasets/%d/fittings' % public_dataset.id
+        )
+
+        assert response.status_code == 200
+        assert response.context['comparisons'] == [
+            (m1, [fit1_m1v1, fit2_m1v2]),
+            (m2, [fit3_m2v]),
+        ]

weblab/datasets/urls.py

@@ -68,4 +68,10 @@
         views.DatasetRenameView.as_view(),
         name='rename',
     ),
+
+    url(
+        r'^(?P<pk>\d+)/fittings$',
+        views.DatasetCompareFittingResultsView.as_view(),
+        name='compare_fittings',
+    ),
 ]

weblab/datasets/views.py

@@ -1,5 +1,6 @@
 import mimetypes
 import os.path
+from itertools import groupby
 from zipfile import ZipFile
 
 from braces.views import UserFormKwargsMixin
@@ -23,6 +24,7 @@
 
 from core.combine import ManifestWriter
 from core.visibility import VisibilityMixin
+from fitting.models import FittingResult
 
 from .forms import (
     DatasetAddFilesForm,
@@ -283,3 +285,38 @@ def post(self, request, *args, **kwargs):
     def get_success_url(self, *args, **kwargs):
         ns = self.request.resolver_match.namespace
         return reverse(ns + ':detail', args=[self._get_object().id])
+
+
+class DatasetCompareFittingResultsView(DetailView):
+    model = Dataset
+    template_name = 'datasets/compare_fittings.html'
+
+    def _get_object(self):
+        if not hasattr(self, 'object'):
+            self.object = self.get_object()
+        return self.object
+
+    def get_context_data(self, **kwargs):
+        dataset = self._get_object()
+
+        fittings = FittingResult.objects.filter(
+            dataset=dataset.pk,
+        ).select_related(
+            'model',
+        ).order_by('model', '-model_version__timestamp')
+
+        # Ensure all are visible to user
+        fittings = [
+            fit for fit in fittings
+            if fit.is_visible_to_user(self.request.user)
+        ]
+
+        def _sorted_fittings(fits):
+            return sorted(list(fits), key=lambda x: x.id)
+
+        kwargs['comparisons'] = [
+            (obj, _sorted_fittings(fits))
+            for (obj, fits) in groupby(fittings, lambda fit: fit.model)
+        ]
+
+        return super().get_context_data(**kwargs)

weblab/entities/templatetags/entities.py

@@ -163,6 +163,17 @@ def url_compare_experiments(entity, commit):
     return reverse(url_name, args=args)
 
 
+@register.filter
+def url_compare_fittings(entity, commit):
+    """Generate the view URL for comparing fitting experiments using
+    a specific version of this entity
+    """
+    url_name = 'entities:compare_fittings'
+    last_tag = _url_friendly_label(entity, commit)
+    args = [entity.url_type, entity.id, last_tag]
+    return reverse(url_name, args=args)
+
+
 @register.filter
 def url_run_experiments(entity, commit):
     last_tag = _url_friendly_label(entity, commit)

weblab/templates/datasets/compare_fittings.html

@@ -0,0 +1,87 @@
+{% extends "base.html" %}
+{% load entities %}
+{% load fittings %}
+{% load staticfiles %}
+
+{% block title %}{{ type|capfirst }}: compare fitting experiments - {% endblock title %}
+
+{% block content %}
+  {% include "./includes/dataset_header.html" %}
+    <div id="entitydetails"></div>
+
+    <div id="entityversion"
+        data-version-href="{% url 'datasets:detail' dataset.id %}"
+        data-version-json-href="{% url 'datasets:version_json' dataset.id %}">
+      <div class="closebtn">
+      </div>
+      <div class="suppl">
+        <small>
+          Created <time id="entityversiontime">{{ dataset.created_at }}</time>
+          by <em id="entityversionauthor">{{ dataset.author.full_name }}</em>.
+          Visibility: <span>{{ dataset.visibility }}</span>
+          <img src="{% static 'img/info.png' %}" alt="help" title="{{ VISIBILITY_HELP }}" />.
+
+  {% comment %}
+          {% can_delete_entity version as can_delete %}
+          {% if can_delete %}
+            Delete experiment version:
+            <a title="delete this version of this experiment" href="{% url 'experiments:delete_version' experiment.id version.id %}">
+              <img src="{% static 'img/delete.png' %}" alt="delete this version of this experiment"
+                  title="delete this version of this experiment"/></a>
+          {% endif %}
+  {% endcomment %}
+
+          <br/>Corresponding protocol:
+            <a href="{% url 'entities:detail' 'protocol' dataset.protocol.pk %}">{{ dataset.protocol.name }}</a>
+
+        </small>
+      </div>
+      <div id="entity-view-buttons" class="link-list">
+        <a class="button" href="{% url "fitting:result:new" %}?dataset={{dataset.pk}}" title="Run fitting experiment using this dataset">Fit</a>
+      </div>
+
+      <p id="description">
+        {{ dataset.description }}
+      </p>
+
+      <div id="experiment-files-switcher">
+      </div>
+      <div id="entityexperimentlist">
+        <h3>Fitting Experiments run with this dataset</h3>
+        <p>
+        This {{type}} has been run with the following models.
+        Click to view the latest results of each single fitting experiment, or select multiple fitting experiments to compare them.
+        </p>
+
+        <div id="entityexperimentlistpartners">
+          <ul>
+            {% for model, fittings in comparisons %}
+
+              <li>
+                {{ model }}
+                <ul>
+                  {% for fitting in fittings %}
+                    <li>
+                      <input name='experimentVersionIds', value="{{ fitting.latest_version.id }}" type="checkbox">
+                      <a href="{% url 'fitting:result:version' fitting.id fitting.latest_version.id %}">
+                        {{ fitting|name_of_fittingspec }}
+                      </a>
+                    </li>
+                  {% endfor %}
+                </ul>
+              </li>
+            {% endfor %}
+          </ul>
+        </div>
+
+        <div id="entityexperimentlistpartnersact">
+          [<a id="entityexperimentlistpartnersactall">select all</a>]
+          <span id="entityexperimentlist_span_latest">[<a id="entityexperimentlistpartnersactlatest">select latest</a>]</span>
+          [<a id="entityexperimentlistpartnersactnone">select none</a>]
+          <br/>
+          <button id="entityexperimentlist_showallversions">show all versions</button>
+          <button id="entityexperimentlistpartnersactcompare" data-base-href="{% url_fitting_comparison_base %}">compare selected fittings</button>
+        </div>
+      </div>
+    </div>
+{% endblock content %}

weblab/templates/datasets/dataset_detail.html

@@ -40,17 +40,15 @@
     </div>
     <div id="entity-view-buttons" class="link-list">
       <a class="button" href="{% url "fitting:result:new" %}?dataset={{dataset.pk}}" title="Run fitting experiment using this dataset">Fit</a>
+      <a class="button" href="{% url "datasets:compare_fittings" dataset.pk %}" title="Show results of parameter fitting experiments run using this dataset">Fittings</a>
+      <br/>
     </div>
 
     <p id="description">
       {{ dataset.description }}
     </p>
 
     <div id="experiment-files-switcher">
-{% comment %}
-      <button style="margin-left:5px; float:left;" id="experiment-files-switcher-exp" title="View &amp; compare experiments using this ${entity.type}">Compare ${otherType}s</button>
-      <br/>
-{% endcomment %}
     </div>
 
     <div id="entityversiondetails">

weblab/templates/datasets/includes/dataset_header.html

@@ -2,7 +2,9 @@
 {% load datasets %}
 
 <h1 id="entityname">
+  <a href="{% url 'datasets:detail' dataset.id %}">
   <small>Dataset: </small><span>{{ dataset.name }}</span>
+  </a>
 </h1>
 
 <div class="suppl">

weblab/templates/entities/entity_version.html

@@ -25,7 +25,7 @@ <h2 id="entityversionname">
     </h2>
 
     <div class="suppl">
-      <small>
+      <small'>
         Created <time id="entityversiontime">{{ version.timestamp }}</time>
         by <em id="entityversionauthor">{{ version.author }}</em>.
         <div id="versionVisibility" data-change-href="{% entity_version_url 'change_visibility' entity version %}">
@@ -70,9 +70,7 @@ <h2 id="entityversionname">
       {% elif entity.entity_type == 'fittingspec' %}
         <a class="button" href="{% url "fitting:result:new" %}?fittingspec_version={{version.pk}}" title="Run fitting experiment using this specification">Fit</a>
       {% endif %}
-      <!--
-      <a class="button" href="" title="Show results of parameter fitting experiments run {% if type == 'model' %}on this model{% else %}using this protocol{% endif %}">Fittings</a>
-      -->
+      <a class="button" href="{% entity_version_url 'compare_fittings' entity version %}" title="Show results of parameter fitting experiments run {% if type == 'model' %}on this model{% else %}using this protocol{% endif %}">Fittings</a>
     </div>
 
     {% block content_detail %}