edc-offstudy


Nameedc-offstudy JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/clinicedc/edc-offstudy
SummaryBase classes for off study process for clinicedc/edc
upload_time2025-01-21 16:56:31
maintainerNone
docs_urlNone
authorErik van Widenfelt
requires_python>=3.12
licenseGPL license, see LICENSE
keywords django edc off-study termination clinicedc clinical trials
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            |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/actions/workflows/build.yml/badge.svg
  :target: https://github.com/clinicedc/edc-offstudy/actions/workflows/build.yml

.. |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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/clinicedc/edc-offstudy",
    "name": "edc-offstudy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "django Edc off-study, termination, clinicedc, clinical trials",
    "author": "Erik van Widenfelt",
    "author_email": "ew2789@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/41/a9/d14ef991533da9a517ac1cb2227e13769888590d6db68683c38d5717f8b2/edc_offstudy-1.0.0.tar.gz",
    "platform": null,
    "description": "|pypi| |actions| |codecov| |downloads|\n\nedc-offstudy\n------------\n\nBase classes for off study process\n\n\nThe offstudy model is linked to scheduled models by the visit schedule.\n\n.. code-block:: python\n\n    # visit_schedule.py\n    ...\n    visit_schedule1 = VisitSchedule(\n        name='visit_schedule1',\n        offstudy_model='edc_offstudy.subjectoffstudy',\n        ...)\n    ...\n\n\nThis module includes an offstudy model ``SubjectOffstudy``.\n\nYou may also declare your own using the ``OffstudyModelMixin``:\n\n.. code-block:: python\n\n    class SubjectOffstudy(OffstudyModelMixin, BaseUuidModel):\n\n         pass\n\nIf you declare your own, be sure to reference it correctly in the visit schedule:\n\n.. code-block:: python\n\n    # visit_schedule.py\n    ...\n    visit_schedule1 = VisitSchedule(\n        name='visit_schedule1',\n        offstudy_model='myapp.subjectoffstudy',\n        ...)\n    ...\n\n\nWhen 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.\nUnused appointments in the future relative to the offstudy datetime will be removed.\n\n Note: There is some redundancy with this model and the offschedule model from ``edc-visit-schedule``. This needs to be resolved.\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/edc-offstudy.svg\n    :target: https://pypi.python.org/pypi/edc-offstudy\n\n.. |actions| image:: https://github.com/clinicedc/edc-offstudy/actions/workflows/build.yml/badge.svg\n  :target: https://github.com/clinicedc/edc-offstudy/actions/workflows/build.yml\n\n.. |codecov| image:: https://codecov.io/gh/clinicedc/edc-offstudy/branch/develop/graph/badge.svg\n  :target: https://codecov.io/gh/clinicedc/edc-offstudy\n\n.. |downloads| image:: https://pepy.tech/badge/edc-offstudy\n   :target: https://pepy.tech/project/edc-offstudy\n",
    "bugtrack_url": null,
    "license": "GPL license, see LICENSE",
    "summary": "Base classes for off study process for clinicedc/edc",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/clinicedc/edc-offstudy"
    },
    "split_keywords": [
        "django edc off-study",
        " termination",
        " clinicedc",
        " clinical trials"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "126ca96aed7e69d0ed4668fcc1c50dc67adb054eeea3348617ec02e5a5296b9a",
                "md5": "e4c12da84752dc1aefe14361e48e469a",
                "sha256": "2fc9f870f5c04b6cfa95fe08ca021cb0f1feb580c8f9de47a6387abbf551552d"
            },
            "downloads": -1,
            "filename": "edc_offstudy-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e4c12da84752dc1aefe14361e48e469a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 55195,
            "upload_time": "2025-01-21T16:56:29",
            "upload_time_iso_8601": "2025-01-21T16:56:29.280497Z",
            "url": "https://files.pythonhosted.org/packages/12/6c/a96aed7e69d0ed4668fcc1c50dc67adb054eeea3348617ec02e5a5296b9a/edc_offstudy-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "41a9d14ef991533da9a517ac1cb2227e13769888590d6db68683c38d5717f8b2",
                "md5": "b4c394dd058ddb14f1cff03a5162b200",
                "sha256": "d36a1f3048a2aee34a93c62299cf66195ee66b79a5aa3a09b4efea24d473700a"
            },
            "downloads": -1,
            "filename": "edc_offstudy-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b4c394dd058ddb14f1cff03a5162b200",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 40753,
            "upload_time": "2025-01-21T16:56:31",
            "upload_time_iso_8601": "2025-01-21T16:56:31.087887Z",
            "url": "https://files.pythonhosted.org/packages/41/a9/d14ef991533da9a517ac1cb2227e13769888590d6db68683c38d5717f8b2/edc_offstudy-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-21 16:56:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "clinicedc",
    "github_project": "edc-offstudy",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "edc-offstudy"
}
        
Elapsed time: 0.38542s