mgnipy.emgapi_v2_client.api.analyses.get_mgnify_analysis module

mgnipy.emgapi_v2_client.api.analyses.get_mgnify_analysis module#

async mgnipy.emgapi_v2_client.api.analyses.get_mgnify_analysis.asyncio(accession, *, client)[source]#

Get MGnify analysis by accession

MGnify analyses are accessioned with an MYGA-prefixed identifier and correspond to an individual Run

or Assembly analysed by a 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:

MGnifyAnalysisDetail

Return type:

MGnifyAnalysisDetail | None

async mgnipy.emgapi_v2_client.api.analyses.get_mgnify_analysis.asyncio_detailed(accession, *, client)[source]#

Get MGnify analysis by accession

MGnify analyses are accessioned with an MYGA-prefixed identifier and correspond to an individual Run

or Assembly analysed by a 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[MGnifyAnalysisDetail]

Return type:

Response[MGnifyAnalysisDetail]

mgnipy.emgapi_v2_client.api.analyses.get_mgnify_analysis.sync(accession, *, client)[source]#

Get MGnify analysis by accession

MGnify analyses are accessioned with an MYGA-prefixed identifier and correspond to an individual Run

or Assembly analysed by a 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:

MGnifyAnalysisDetail

Return type:

MGnifyAnalysisDetail | None

mgnipy.emgapi_v2_client.api.analyses.get_mgnify_analysis.sync_detailed(accession, *, client)[source]#

Get MGnify analysis by accession

MGnify analyses are accessioned with an MYGA-prefixed identifier and correspond to an individual Run

or Assembly analysed by a 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[MGnifyAnalysisDetail]

Return type:

Response[MGnifyAnalysisDetail]

Contents