coord2region.cli#

Command-line interface for Coord2Region.

The CLI provides dedicated sub-commands tailored to the different capabilities exposed by the pipeline. Coordinate-focused commands can map MNI coordinates to atlas labels, retrieve related studies, generate summaries, render images and combine these insights. Region-based commands resolve atlas region names to coordinates before performing the same operations.

Functions#

run_from_config(→ None)

Execute the pipeline using a YAML configuration file.

create_parser(→ argparse.ArgumentParser)

Create the top-level argument parser for the CLI.

main(→ None)

Entry point for the coord2region console script.

Module Contents#

coord2region.cli.run_from_config(path: str, *, dry_run: bool = False) None[source]#

Execute the pipeline using a YAML configuration file.

coord2region.cli.create_parser() ArgumentParser[source]#

Create the top-level argument parser for the CLI.

coord2region.cli.main(argv: Sequence[str] | None = None) None[source]#

Entry point for the coord2region console script.