mgnipy.emgapi_v2_client.api.analyses.list_mgnify_analyses module

mgnipy.emgapi_v2_client.api.analyses.list_mgnify_analyses module#

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

List all analyses (MGYAs) available from MGnify

Each analysis is the result of a Pipeline execution on a reads dataset (either a raw read-run, or an

assembly).

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:

NinjaPaginationResponseSchemaMGnifyAnalysisDetail

Return type:

NinjaPaginationResponseSchemaMGnifyAnalysisDetail | None

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

List all analyses (MGYAs) available from MGnify

Each analysis is the result of a Pipeline execution on a reads dataset (either a raw read-run, or an

assembly).

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifyAnalysisDetail]

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

List all analyses (MGYAs) available from MGnify

Each analysis is the result of a Pipeline execution on a reads dataset (either a raw read-run, or an

assembly).

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:

NinjaPaginationResponseSchemaMGnifyAnalysisDetail

Return type:

NinjaPaginationResponseSchemaMGnifyAnalysisDetail | None

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

List all analyses (MGYAs) available from MGnify

Each analysis is the result of a Pipeline execution on a reads dataset (either a raw read-run, or an

assembly).

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifyAnalysisDetail]

Contents