Skip to content
This repository was archived by the owner on Aug 27, 2025. It is now read-only.

Commit 264f07b

Browse files
add --spot argument to CLI
1 parent 21e64c6 commit 264f07b

2 files changed

Lines changed: 3 additions & 0 deletions

File tree

docs/cli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ $ spatialdata_xenium_explorer write [OPTIONS] SDATA_PATH
107107
* `--points-key TEXT`: Name of the transcripts (key of `sdata.points`). This argument doesn't need to be provided if there is only one points key.
108108
* `--gene-column TEXT`: Column name of the points dataframe containing the gene names
109109
* `--pixelsize FLOAT`: Number of microns in a pixel. Invalid value can lead to inconsistent scales in the Explorer. [default: 0.2125]
110+
* `--spot / --no-spot`: Whether the technology is based on spots [default: no-spot]
110111
* `--layer TEXT`: Layer of `sdata.table` where the gene counts are saved. If `None`, uses `sdata.table.X`.
111112
* `--lazy / --no-lazy`: If `True`, will not load the full images in memory (except if the image memory is below `ram_threshold_gb`) [default: lazy]
112113
* `--ram-threshold-gb INTEGER`: Threshold (in gygabytes) from which image can be loaded in memory. If `None`, the image is never loaded in memory [default: 4]

spatialdata_xenium_explorer/cli/app.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ def write(
3131
0.2125,
3232
help="Number of microns in a pixel. Invalid value can lead to inconsistent scales in the Explorer.",
3333
),
34+
spot: bool = typer.Option(False, help="Whether the technology is based on spots"),
3435
layer: str = typer.Option(
3536
None,
3637
help="Layer of `sdata.table` where the gene counts are saved. If `None`, uses `sdata.table.X`.",
@@ -68,6 +69,7 @@ def write(
6869
points_key=points_key,
6970
gene_column=gene_column,
7071
pixelsize=pixelsize,
72+
spot=spot,
7173
layer=layer,
7274
lazy=lazy,
7375
ram_threshold_gb=ram_threshold_gb,

0 commit comments

Comments
 (0)