common_reports_api package

Subpackages

• common_reports_api.tests package
  • Submodules
  • common_reports_api.tests.test_common_reports_api module
    • test_autogenerate_common_report()
    • test_families_data_all_download()
    • test_families_data_all_download_no_permissions()
    • test_families_data_download()
    • test_families_data_download_no_permissions()
    • test_families_tags_download()
    • test_families_tags_download_errors_on_bad_body()
    • test_family_counters()
    • test_family_counters_download()
    • test_variant_reports()
    • test_variant_reports_full()
    • test_variant_reports_has_permissions()
    • test_variant_reports_permissions()
  • Module contents

Submodules

common_reports_api.urls module

common_reports_api.views module

class common_reports_api.views.FamiliesDataDownloadView

Bases: QueryBaseView, DatasetAccessRightsView

Families data download view class.

classmethod collect_families(study_families: FamiliesData, tags_query: dict[str, Any] | None) → FamiliesData

Collect and filter families by tags.

get(_request: Request, dataset_id: str) → Response

Return full family data for a specified study.

post(request: Request, dataset_id: str) → Response

Return full family data for a specified study and tags.

class common_reports_api.views.FamilyCounterDownloadView

Bases: QueryBaseView, DatasetAccessRightsView

Family counters download view class.

post(request: Request) → Response

Return family couters for a specified study and group name.

class common_reports_api.views.FamilyCounterListView

Bases: QueryBaseView, DatasetAccessRightsView

Family couters list view class.

post(request: Request) → Response

Return family counters for specified study and group name.

class common_reports_api.views.VariantReportsFullView

Bases: QueryBaseView, DatasetAccessRightsView

Variants report full view class.

get(_request: Request, common_report_id: str) → Response

Return full variant report when requested.

class common_reports_api.views.VariantReportsView

Bases: QueryBaseView

Variant reports view class.

get(_request: Request, common_report_id: str) → Response

Return a variant report when requested.

Module contents