Metadata-Version: 2.1
Name: edc-offstudy
Version: 0.3.20
Summary: Base classes for off study process for clinicedc/edc
Home-page: https://github.com/clinicedc/edc-offstudy
Author: Erik van Widenfelt
Author-email: ew2789@gmail.com
License: GPL license, see LICENSE
Keywords: django Edc off-study,termination,clinicedc,clinical trials
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS

|pypi| |actions| |codecov| |downloads|

edc-offstudy
------------

Base classes for off study process


The offstudy model is linked to scheduled models by the visit schedule.

.. code-block:: python

    # visit_schedule.py
    ...
    visit_schedule1 = VisitSchedule(
        name='visit_schedule1',
        offstudy_model='edc_offstudy.subjectoffstudy',
        ...)
    ...


This module includes an offstudy model ``SubjectOffstudy``.

You may also declare your own using the ``OffstudyModelMixin``:

.. code-block:: python

    class SubjectOffstudy(OffstudyModelMixin, BaseUuidModel):

         pass

If you declare your own, be sure to reference it correctly in the visit schedule:

.. code-block:: python

    # visit_schedule.py
    ...
    visit_schedule1 = VisitSchedule(
        name='visit_schedule1',
        offstudy_model='myapp.subjectoffstudy',
        ...)
    ...


When the offstudy model is saved, the data is validated relative to the consent and **visit model**. An offstudy datetime should make sense relative to these model instances for the subject.
Unused appointments in the future relative to the offstudy datetime will be removed.

 Note: There is some redundancy with this model and the offschedule model from ``edc-visit-schedule``. This needs to be resolved.


.. |pypi| image:: https://img.shields.io/pypi/v/edc-offstudy.svg
    :target: https://pypi.python.org/pypi/edc-offstudy

.. |actions| image:: https://github.com/clinicedc/edc-offstudy/workflows/build/badge.svg?branch=develop
  :target: https://github.com/clinicedc/edc-offstudy/actions?query=workflow:build

.. |codecov| image:: https://codecov.io/gh/clinicedc/edc-offstudy/branch/develop/graph/badge.svg
  :target: https://codecov.io/gh/clinicedc/edc-offstudy

.. |downloads| image:: https://pepy.tech/badge/edc-offstudy
   :target: https://pepy.tech/project/edc-offstudy
