Commit 310a18ea authored by Mathieu Courcelles's avatar Mathieu Courcelles

Added dashboard with quick start documentation.

parent 31e98480
"""
This file was generated with the customdashboard management command and
contains the class for the main dashboard.
To activate your index dashboard add the following to your settings.py::
GRAPPELLI_INDEX_DASHBOARD = 'MSQCdb.dashboard.CustomIndexDashboard'
"""
from django.utils.translation import ugettext_lazy as _
from django.core.urlresolvers import reverse
from grappelli.dashboard import modules, Dashboard
from grappelli.dashboard.utils import get_admin_site_name
class CustomIndexDashboard(Dashboard):
"""
Custom index dashboard for www.
"""
def init_with_context(self, context):
site_name = get_admin_site_name(context)
# append an app list module for "Applications"
self.children.append(modules.AppList(
_('Applications'),
collapsible=True,
column=2,
css_classes=('collapse closed',),
exclude=('django.contrib.*',),
))
# append an app list module for "Administration"
self.children.append(modules.ModelList(
_('Administration'),
column=2,
#collapsible=False,
models=('django.contrib.*',),
))
# append another link list module for "Quick start".
self.children.append(modules.LinkList(
_('Quick start'),
column=1,
collapsible=True,
post_content='<ul class="grp-listing-small">\
<li class="grp-row"><br />\
<h2>Step 1. Raw dataset upload</h2><br />\
Cross-link identifications from either pLink, xQuest\
or Xi must first be inserted into database. Click \
the <strong>Add</strong> link next to <strong>Raw datasets</strong> to\
to upload your result file.\
<br/><br/>\
All uploaded datasets are available in <strong>Raw datasets</strong>\
section. From there, cross-linked peptides can be seen by clicking\
on <strong>See</strong> link. Cross-linked peptides of selected datasets\
can be exported to <strong>Xi CSV</strong> result format using the action\
drop-down box at the bottom of the page.\
<br/><br/><br/>\
\
<h2>Step 2. Dataset processing</h2><br />\
Datasets can be merged to a single dataset and their cross-linked\
peptides filtered by score, mass tolerance, length, false positives, etc.\
Click the <strong>Add</strong> link next to <strong>Processed \
datasets</strong> to create a grouped/filtered dataset\
from a raw or processed datasets.\
<br/><br/>\
Filtering of cross-linked peptides is accomplished using\
a pre-defined filter. Use one available or create a new one\
by clicking the <strong>Add</strong> link next to <strong>\
Cl peptide filters</strong>.\
<br/><br/>\
The created dataset is then available in <strong>Processed \
datasets</strong> and cross-linked peptides can be seen by clicking\
on <strong>See</strong> link. Like Raw dataset, cross-linked peptides\
can also be export to <strong>Xi CSV</strong>.\
<br/><br/>\
</li>\
</ul>',
))
# append a recent actions module
self.children.append(modules.RecentActions(
_('Recent Actions'),
limit=10,
#collapsible=False,
column=3,
))
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment