tiledbsoma.DataFrame.tiledbsoma_resize_soma_joinid_shape

DataFrame.tiledbsoma_resize_soma_joinid_shape(newshape: int, check_only: bool = False) → tuple[bool, str]

Increases the shape of the dataframe on the soma_joinid index column, if it indeed is an index column, leaving all other index columns as-is.

If the soma_joinid is not an index column, no change is made. This is a special case of upgrade_domain, but simpler to keystroke, and handles the most common case for dataframe domain expansion.

Raises an error if the dataframe doesn’t already have a domain: in that case please call tiledbsoma_upgrade_domain.

If check_only is True, returns whether the operation would succeed if attempted, and a reason why it would not.