Skip to contents

Function template, where basic parameter documentation can be obtained from

Usage

template_BascetFunction(
  bascetRoot,
  runner = GetDefaultBascetRunner(),
  bascet_instance = GetDefaultBascetInstance()
)

Arguments

bascetRoot

The root folder where all Bascets are stored

runner

The job manager, specifying how the command will be run (e.g. locally, or via SLURM)

bascet_instance

Configuration for how to run the Bascet Rust API

num_output_shards

Number of output shards, i.e., how many output files to split the data into? (>=1)

includeCells

List of cells to process

bascetFile

Handle for an opened Bascet file

cellID

ID of the cell (string)

verbose

description

Value

A job to be executed