anatools.anaclient.umap module

UMAP Functions

create_umap(self, name, datasetIds, samples, description=None, seed=None, tags=None, workspaceId=None)

Creates a UMAP dataset comparison job on the platform.

Parameters

• datasetIds ([str]) – Dataset ID to retrieve information for.

• samples ([int]) – Samples to take from each dataset.

• workspaceId (str) – Workspace ID where the datasets exists.

Returns

The UMAP Job ID.

Return type

str

delete_umap(self, umapId, workspaceId=None)

Deletes/cancels a UMAP dataset comparison on the platform.

Parameters

• umapId (str) – UMAP Job ID.

• workspaceId (str) – Workspace ID where the datasets exists.

Returns

Status.

Return type

bool

edit_umap(self, umapId, name=None, description=None, tags=None, workspaceId=None)

Edits a UMAP dataset comparison on the platform.

Parameters

• umapId (str) – UMAP Job ID.

• name (str) – Name of the UMAP.

• description (str) – Description of the UMAP.

• workspaceId (str) – Workspace ID where the datasets exists.

Returns

Status.

Return type

bool

get_umaps(self, umapId=None, datasetId=None, workspaceId=None, cursor=None, limit=None, filters=None, fields=None)

Retrieves information about UMAP dataset comparison from the platform.

Parameters

• umapId (str) – UMAP Job ID.

• datasetId (str) – Dataset Id to filter on.

• workspaceId (str) – Workspace ID where the datasets exists.

• cursor (str) – Cursor for pagination.

• limit (int) – Maximum number of umaps to return.

• filters (dict) – Filters that limit output to entries that match the filter

• fields (list) – List of fields to return, leave empty to get all fields.

Returns

UMAP information.

Return type

dict