mgnipy.emgapi_v2_client.api.analyses.analysis_get_mgnify_analysis_with_annotations module

mgnipy.emgapi_v2_client.api.analyses.analysis_get_mgnify_analysis_with_annotations module#

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

Get MGnify analysis by accession, with annotations and downloadable files

MGnify analyses have annotations (taxonomic and functional assignments), and downloadable files

(outputs from the pipeline execution).

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:

MGnifyAnalysisWithAnnotations

Return type:

MGnifyAnalysisWithAnnotations | None

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

Get MGnify analysis by accession, with annotations and downloadable files

MGnify analyses have annotations (taxonomic and functional assignments), and downloadable files

(outputs from the pipeline execution).

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

Return type:

Response[MGnifyAnalysisWithAnnotations]

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

Get MGnify analysis by accession, with annotations and downloadable files

MGnify analyses have annotations (taxonomic and functional assignments), and downloadable files

(outputs from the pipeline execution).

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:

MGnifyAnalysisWithAnnotations

Return type:

MGnifyAnalysisWithAnnotations | None

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

Get MGnify analysis by accession, with annotations and downloadable files

MGnify analyses have annotations (taxonomic and functional assignments), and downloadable files

(outputs from the pipeline execution).

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

Return type:

Response[MGnifyAnalysisWithAnnotations]

Contents