Source code for camcops_server.tasks.paradise24

#!/usr/bin/env python

"""
camcops_server/tasks/paradise24.py

===============================================================================

    Copyright (C) 2012, University of Cambridge, Department of Psychiatry.
    Created by Rudolf Cardinal (rnc1001@cam.ac.uk).

    This file is part of CamCOPS.

    CamCOPS is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    CamCOPS is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with CamCOPS. If not, see <https://www.gnu.org/licenses/>.

===============================================================================

**PARADISE 24 task.**

"""

from typing import Any, Dict, Optional, Type, Tuple

from cardinal_pythonlib.stringfunc import strseq
from sqlalchemy.ext.declarative import DeclarativeMeta
from sqlalchemy.sql.sqltypes import Integer

from camcops_server.cc_modules.cc_constants import CssClass
from camcops_server.cc_modules.cc_db import add_multiple_columns
from camcops_server.cc_modules.cc_html import tr_qa, tr, answer
from camcops_server.cc_modules.cc_request import CamcopsRequest
from camcops_server.cc_modules.cc_task import TaskHasPatientMixin, Task


class Paradise24Metaclass(DeclarativeMeta):
    def __init__(
        cls: Type["Paradise24"],
        name: str,
        bases: Tuple[Type, ...],
        classdict: Dict[str, Any],
    ) -> None:

        add_multiple_columns(
            cls,
            cls.Q_PREFIX,
            cls.FIRST_Q,
            cls.LAST_Q,
            coltype=Integer,
            minimum=0,
            maximum=2,
            comment_fmt="Q{n} - {s}",
            comment_strings=[
                "rested 0-2 (none - a lot)",
                "loss interest 0-2 (none - a lot)",
                "appetite 0-2 (none - a lot)",
                "sleeping 0-2 (none - a lot)",
                "irritable 0-2 (none - a lot)",
                "slowed down 0-2 (none - a lot)",
                "sad 0-2 (none - a lot)",
                "worry 0-2 (none - a lot)",
                "cope 0-2 (none - a lot)",
                "pain 0-2 (none - a lot)",
                "concentrating 0-2 (none - a lot)",
                "remembering 0-2 (none - a lot)",
                "decisions 0-2 (none - a lot)",
                "conversation 0-2 (none - a lot)",
                "walking 0-2 (none - a lot)",
                "grooming 0-2 (none - a lot)",
                "sexual 0-2 (none - a lot)",
                "staying by yourself 0-2 (none - a lot)",
                "health 0-2 (none - a lot)",
                "friendship 0-2 (none - a lot)",
                "getting along 0-2 (none - a lot)",
                "work or school 0-2 (none - a lot)",
                "money 0-2 (none - a lot)",
                "community 0-2 (none - a lot)",
            ],
        )

        super().__init__(name, bases, classdict)


[docs]class Paradise24(TaskHasPatientMixin, Task, metaclass=Paradise24Metaclass): __tablename__ = "paradise24" shortname = "PARADISE 24" Q_PREFIX = "q" FIRST_Q = 1 LAST_Q = 24 ALL_FIELD_NAMES = strseq(Q_PREFIX, FIRST_Q, LAST_Q)
[docs] @staticmethod def longname(req: CamcopsRequest) -> str: _ = req.gettext return _( "Psychosocial fActors Relevant to BrAin DISorders in Europe–24" )
[docs] def is_complete(self) -> bool: if self.any_fields_none(self.ALL_FIELD_NAMES): return False return True
def total_score(self) -> Optional[int]: if not self.is_complete(): return None return self.sum_fields(self.ALL_FIELD_NAMES) def metric_score(self) -> Optional[int]: total_score = self.total_score() if total_score is None: return None # Table 3 of Cieza et al. (2015); see help. # - doi:10.1371/journal.pone.0132410.t003 # - Indexes are raw scores. # - Values are transformed scores. score_lookup = [ 0, # 0 10, 19, 25, 29, 33, 36, 38, 41, 43, 45, # 10 46, 48, 50, 51, 53, 54, 55, 57, 58, 59, # 20 60, 61, 63, 64, 65, 66, 67, 68, 69, 71, # 30 72, 73, 74, 76, 77, 78, 80, 81, 83, 85, # 40 87, 89, 91, 92, 94, 96, 98, 100, # 48 ] try: return score_lookup[total_score] except (IndexError, TypeError): return None
[docs] def get_task_html(self, req: CamcopsRequest) -> str: rows = "" for q_num in range(self.FIRST_Q, self.LAST_Q + 1): field = self.Q_PREFIX + str(q_num) question_cell = f"{q_num}. {self.xstring(req, field)}" rows += tr_qa(question_cell, self.get_answer_cell(req, q_num)) html = """ <div class="{CssClass.SUMMARY}"> <table class="{CssClass.SUMMARY}"> {tr_is_complete} {total_score} {metric_score} </table> </div> <table class="{CssClass.TASKDETAIL}"> <tr> <th width="60%">Question</th> <th width="40%">Score</th> </tr> {rows} </table> <div class="{CssClass.FOOTNOTES}"> [1] Sum of all questions, range 0–48. [2] Transformed metric scale, range 0–100. </div> """.format( CssClass=CssClass, tr_is_complete=self.get_is_complete_tr(req), total_score=tr( self.wxstring(req, "raw_score") + " <sup>[1]</sup>", f"{answer(self.total_score())}", ), metric_score=tr( self.wxstring(req, "metric_score") + " <sup>[2]</sup>", f"{answer(self.metric_score())}", ), rows=rows, ) return html
def get_answer_cell(self, req: CamcopsRequest, q_num: int) -> str: q_field = self.Q_PREFIX + str(q_num) score = getattr(self, q_field) meaning = self.get_score_meaning(req, score) answer_cell = f"{score} [{meaning}]" return answer_cell def get_score_meaning(self, req: CamcopsRequest, score: int) -> str: return self.wxstring(req, f"option_{score}")