mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_analyses module

mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_analyses module#

async asyncio(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List MGnify Analyses associated with this Study

MGnify analyses correspond to an individual Run or Assembly within this study,analysed by a MGnify

Pipeline.

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:

NinjaPaginationResponseSchemaMGnifyAnalysis

Return type:

NinjaPaginationResponseSchemaMGnifyAnalysis | None

async asyncio_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List MGnify Analyses associated with this Study

MGnify analyses correspond to an individual Run or Assembly within this study,analysed by a MGnify

Pipeline.

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[NinjaPaginationResponseSchemaMGnifyAnalysis]

Return type:

Response[NinjaPaginationResponseSchemaMGnifyAnalysis]

sync(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List MGnify Analyses associated with this Study

MGnify analyses correspond to an individual Run or Assembly within this study,analysed by a MGnify

Pipeline.

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:

NinjaPaginationResponseSchemaMGnifyAnalysis

Return type:

NinjaPaginationResponseSchemaMGnifyAnalysis | None

sync_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List MGnify Analyses associated with this Study

MGnify analyses correspond to an individual Run or Assembly within this study,analysed by a MGnify

Pipeline.

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[NinjaPaginationResponseSchemaMGnifyAnalysis]

Return type:

Response[NinjaPaginationResponseSchemaMGnifyAnalysis]

Contents