Command line arguments¶
The general usage of OpenTabulate in the command line is of the form:
opentab [arguments] [SOURCE [SOURCE ...]]
SOURCE
here is the path of a source file. Multiple source file paths can be included to process in the same command. Remember that the data associated with a source file, i.e. its localfile
tag must placed in the input data directory.
The various command-line arguments are shown in the sections below and are organized by
- Flag : Value Type : Possible Values (if applicable)
- Description…
Runtime arguments¶
-h
,--help
: none- Print the command-line tool help prompt to standard output.
--initialize
: none- Create the data processing directories used by OpenTabulate in
$root_directory
. -c
,--copy-config
: none- Copy the example configuration file provided in the package to
~/.config.opentabulate.conf
. -s
,--verify-source
: none- Validate the given source files without processing their corresponding datasets. Use for checking source file syntax.
--clear-cache
: none- Reset the data processing redundancy cache. The cache stores hash digests of the input data to prevent redundant processing of input in future runs. Note that if an input encounters an error during processing, its hash digest is not cached. The data processing redundancy cache is located at
~/.cache/opentabulate/process_cache
. --ignore-cache
: none- Ignore hash digest comparisons with the redundancy cache when processing data. Note that the redundancy cache is still updated when using this flag. For more details on the redundancy cache, read the description for the
--clear-cache
flag above. -t N
,--threads N
: integer : N > 0- Run data processing tasks on N threads. This defaults to one thread if the option is not specified.
Configuration arguments¶
These options override those configured in the configuration file ~/.config/opentabulate.conf
.
--add-index BOOL
: boolean- Insert index column to output. This overrides the
add_index
configuration option. --target-enc ENCODING
: string : cp1252, utf-8- Character encoding of the output. This overrides the
target_encoding
configuration option. --output-enc-errors HANDLER
: string : strict, replace, ignoreError handling when re-encoding the input encoding to the target output encoding.
- strict throws an error upon a failed encoding and ceases processing
- replace substitutes failed encodings with ?
- ignore discards failed encodings from the output
This overrides the
output_encoding_errors
configuration option.--clean-ws BOOL
: boolean- Toggle whether or not extraneous whitespace should be cleaned. This overrides the
clean_whitespace
configuration option. --lowercase BOOL
: boolean- Toggle whether or not all output characters should be lowercase. This overrides the
lowercase_entries
configuration option. -l N
,--log-level N
: integer : 0, 1, 2, 3- Set the logger level verbosity. The lower the level, the more verbose. Primarily used for debugging. This overrides the
verbosity_level
configuration option.