Command Line Interface

usage: cobrawap [-h] [-v] [-V]
                {init,settings,create,add_profile,run,run_stage,run_block} ...

Named Arguments

-v, --verbose

print additional logging information

Default: False

-V, --version

show program’s version number and exit

Sub-commands

init

initialize the cobrawap directories (required only once)

cobrawap init [-h] [--output_path OUTPUT_PATH] [--config_path CONFIG_PATH]

Named Arguments

--output_path

directory where the analysis output is stored [default: ‘~/cobrawap_output/’]

--config_path

directory where the analysis config files are stored [default: ‘~/cobrawap_config/’]

settings

display the content of ~/.cobrawap/config

cobrawap settings [-h]

create

create configuration for a new dataset

cobrawap create [-h] [--data_path [DATA_PATH]]
                [--loading_script_name [LOADING_SCRIPT_NAME]]
                [--profile [PROFILE]] [--parent_profile [PARENT_PROFILE]]

Named Arguments

--data_path

full path to the dataset to be analyzed (or where it will be stored)

--loading_script_name

name of the data specific loading script (in <config_path>/stage01_data_entry/scripts/)

--profile

profile name of this dataset/application (see profile name conventions in documentation)

--parent_profile

optional parent profile name (see profile name conventions in documentation)

add_profile

create a new configuration for an existing dataset

cobrawap add_profile [-h] [--profile [PROFILE]] [--stages [{} ...]]
                     [--parent_profile [PARENT_PROFILE]]

Named Arguments

--profile

profile name of this dataset/application (see profile name conventions in documentation)

--stages

selection of pipeline stages to configure

--parent_profile

optional parent profile name from which to initialize the new config [default: basic template]

run

run the analysis pipeline on the selected input and with the specified configurations

cobrawap run [-h] [--profile [PROFILE]]

Named Arguments

--profile

name of the config profile to be analyzed

run_stage

execute an individual stage

cobrawap run_stage [-h] [--stage [{}]] [--profile [PROFILE]]

Named Arguments

--stage

select individual stage to execute

--profile

name of the config profile to be analyzed

run_block

execute an individual block method on some input

cobrawap run_block [-h] [--stage [{}]] [--block [BLOCK]] [--block_help]

Named Arguments

--stage

select individual stage to execute

--block

select individual block to execute

--block_help

display the help text of the block script

Default: False