inspect_table
Inspect a table file a node is serving, before deciding how to read it.
from plexora import inspect_tableinspect_table(name, resource_id, table=None)Has the node look at the file's structure and returns the same kind of
document a local import screen works from, so the questions about a
remote file ("which column is the cell id?") are asked in exactly the
words they are asked about a local one. plexora.attach_table calls this
itself when it has nothing else to build a read spec from.
Parameters
namestrrequiredThe registered node's name.
resource_idstrrequiredThe table resource's id on that node (see
plexora.node_resources).
tablestrdefault NoneWhich table to inspect, for a file that holds
more than one (a SpatialData .zarr store).
Returns
dictThe node's structural inspection of the file -- data_type,
obs_columns, obsm_keys, layers and a proposed read spec under
proposed, plus tables when the file holds more than one table and
none was named in table.
Raises
KeyErrorIf no node named name is registered.
Examples
import plexora
document = plexora.inspect_table("hpc", "cells")