`tar_viewer`

Package G4X-viewer Folder for Distribution

Tars a G4X-viewer folder by validating and organizing key viewer assets (e.g., .bin, .ome.tiff, .tar, etc.), generating the required dataset.config.json metadata file, and creating a .tar archive ready for use with the Single-File upload option in the G4X-viewer.

Usage

g4x-helpers tar_viewer --help

Note

Global options --threads/-t & --verbose/-v must be supplied on the main entrypoint before the subcommand:

g4x-helpers --threads 16 -v 2 COMMAND /path/to/g4x_data [OPTIONS]

use g4x-helpers --help for more information

Arguments / Options

`G4X-DATA`

type : directory
example : path/to/g4x_output

Positional path to a G4X sample output directory.
The folder must follow the expected schema (e.g., contain run_meta.json, segmentation masks, panel files, single-cell outputs).
Provide this argument directly after the specified command, i.e:
g4x-helpers COMMAND G4X-DATA

`--in-place`

type : flag
default : not set

By default, commands write their outputs to <G4X-DATA>/g4x_helpers/<command>, leaving the original data untouched. Using --in-place instead writes outputs directly into the specified G4X-DATA directory, which may be required when chaining certain commands.

Note: this will override any existing artifacts modified by the command.
Please refer to each feature’s documentation to see which files may be updated.

⸻