mgnipy.emgapi_v2_client.api.studies.list_mgnify_studies module

async mgnipy.emgapi_v2_client.api.studies.list_mgnify_studies.asyncio(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, has_analyses_from_pipeline=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all studies analysed by MGnify

MGnify studies inherit directly from studies (or projects) in ENA.

Parameters:

• order (ListMgnifyStudiesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• has_analyses_from_pipeline (None | PipelineVersions | Unset) – If set, will only show studies with analyses from the specified MGnify pipeline version

• search (None | str | Unset) – Search within study titles and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

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:

NinjaPaginationResponseSchemaMGnifyStudy

Return type:

NinjaPaginationResponseSchemaMGnifyStudy | None

async mgnipy.emgapi_v2_client.api.studies.list_mgnify_studies.asyncio_detailed(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, has_analyses_from_pipeline=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all studies analysed by MGnify

MGnify studies inherit directly from studies (or projects) in ENA.

Parameters:

• order (ListMgnifyStudiesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• has_analyses_from_pipeline (None | PipelineVersions | Unset) – If set, will only show studies with analyses from the specified MGnify pipeline version

• search (None | str | Unset) – Search within study titles and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifyStudy]

mgnipy.emgapi_v2_client.api.studies.list_mgnify_studies.sync(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, has_analyses_from_pipeline=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all studies analysed by MGnify

MGnify studies inherit directly from studies (or projects) in ENA.

Parameters:

• order (ListMgnifyStudiesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• has_analyses_from_pipeline (None | PipelineVersions | Unset) – If set, will only show studies with analyses from the specified MGnify pipeline version

• search (None | str | Unset) – Search within study titles and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

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:

NinjaPaginationResponseSchemaMGnifyStudy

Return type:

NinjaPaginationResponseSchemaMGnifyStudy | None

mgnipy.emgapi_v2_client.api.studies.list_mgnify_studies.sync_detailed(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, has_analyses_from_pipeline=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all studies analysed by MGnify

MGnify studies inherit directly from studies (or projects) in ENA.

Parameters:

• order (ListMgnifyStudiesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• has_analyses_from_pipeline (None | PipelineVersions | Unset) – If set, will only show studies with analyses from the specified MGnify pipeline version

• search (None | str | Unset) – Search within study titles and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifyStudy]