mgnipy.emgapi_v2_client.api.studies.get_super_study module

mgnipy.emgapi_v2_client.api.studies.get_super_study module#

async mgnipy.emgapi_v2_client.api.studies.get_super_study.asyncio(slug, *, client)[source]#

Get the detail of a single Super Study

A Super Study is a collection of MGnify Studies all related to a single large initiative. They may

also reference Genome Catalogues that were assembled from the Studies or as part of the Super Study initiative.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

SuperStudyDetail

Return type:

SuperStudyDetail | None

async mgnipy.emgapi_v2_client.api.studies.get_super_study.asyncio_detailed(slug, *, client)[source]#

Get the detail of a single Super Study

A Super Study is a collection of MGnify Studies all related to a single large initiative. They may

also reference Genome Catalogues that were assembled from the Studies or as part of the Super Study initiative.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[SuperStudyDetail]

Return type:

Response[SuperStudyDetail]

mgnipy.emgapi_v2_client.api.studies.get_super_study.sync(slug, *, client)[source]#

Get the detail of a single Super Study

A Super Study is a collection of MGnify Studies all related to a single large initiative. They may

also reference Genome Catalogues that were assembled from the Studies or as part of the Super Study initiative.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

SuperStudyDetail

Return type:

SuperStudyDetail | None

mgnipy.emgapi_v2_client.api.studies.get_super_study.sync_detailed(slug, *, client)[source]#

Get the detail of a single Super Study

A Super Study is a collection of MGnify Studies all related to a single large initiative. They may

also reference Genome Catalogues that were assembled from the Studies or as part of the Super Study initiative.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[SuperStudyDetail]

Return type:

Response[SuperStudyDetail]

Contents