configure_project
Answer questions about a project that is already registered.
from plexora import configure_projectconfigure_project(name, **answers) -> dictWhatever is passed is recorded as a confirmed answer, never as a guess --
the same distinction create_project records at registration time. Use
it once you know something Plexora could not read from the files
themselves: which table inside a multi-table store, or which column is
the cell id when its name did not match Plexora's guess.
When to use
Call this any time after create_project or import_sample to fill
in, or correct, an answer about a project that already exists.
Parameters
namestrrequiredThe project's name.
**answersAny of the table/column keys create_project takes --
segmentation, data, table, subset, cell_id, x, y,
sample, celltype, markers, metadata, coordinates,
layer, log1p, single_image, row_number_ids, dataset
and node -- each meaning exactly what it means there. image,
name, copy, channel_names and exist_ok only make sense
when a project is first registered, and are refused here.
Returns
dictThe project's manifest -- see project_manifest -- so the
caller can see what is still open.
Raises
KeyErrorIf no project is registered under name.
ValueErrorIf answers contains an unknown key, if table or
subset is given with no data on record to read a table
inside of, or if a column answer cannot be applied (an unknown
layer name, say) -- in which case the project is left exactly as
it was before the call.
Examples
import plexora
plexora.create_project("slide.ome.tif", data="cells.csv")
info = plexora.configure_project(
"slide", cell_id="CellID", x="X_centroid", y="Y_centroid")
print(info["summary"])Related
project_manifest
What one project has, what it was told, and what is still open.
create_project
Register one project and return its name.