kb_python.main

Module Contents

Functions

display_info()

Displays kb, kallisto and bustools version + citation information, along

display_technologies()

Displays a list of supported technologies along with whether kb provides

parse_ref(parser, args, temp_dir='tmp')

Parser for the ref command.

parse_count(parser, args, temp_dir='tmp')

Parser for the count command.

setup_info_args(parser, parent)

Helper function to set up a subparser for the info command.

setup_ref_args(parser, parent)

Helper function to set up a subparser for the ref command.

setup_count_args(parser, parent)

Helper function to set up a subparser for the count command.

main()

Command-line entrypoint.

Attributes

COMMAND_TO_FUNCTION

kb_python.main.display_info()

Displays kb, kallisto and bustools version + citation information, along with a brief description and examples.

kb_python.main.display_technologies()

Displays a list of supported technologies along with whether kb provides a whitelist for that technology and the FASTQ argument order for kb count.

kb_python.main.parse_ref(parser, args, temp_dir='tmp')

Parser for the ref command.

Parameters

args (dict) – Command-line arguments dictionary, as parsed by argparse

kb_python.main.parse_count(parser, args, temp_dir='tmp')

Parser for the count command.

Parameters

args (dict) – Command-line arguments dictionary, as parsed by argparse

kb_python.main.COMMAND_TO_FUNCTION
kb_python.main.setup_info_args(parser, parent)

Helper function to set up a subparser for the info command.

Parameters
  • parser – argparse parser to add the info command to

  • parent – argparse parser parent of the newly added subcommand. used to inherit shared commands/flags

Returns

the newly added parser

Return type

argparse.ArgumentParser

kb_python.main.setup_ref_args(parser, parent)

Helper function to set up a subparser for the ref command.

Parameters
  • parser – argparse parser to add the ref command to

  • parent – argparse parser parent of the newly added subcommand. used to inherit shared commands/flags

Returns

the newly added parser

Return type

argparse.ArgumentParser

kb_python.main.setup_count_args(parser, parent)

Helper function to set up a subparser for the count command.

Parameters
  • parser – argparse parser to add the count command to

  • parent – argparse parser parent of the newly added subcommand. used to inherit shared commands/flags

Returns

the newly added parser

Return type

argparse.ArgumentParser

kb_python.main.main()

Command-line entrypoint.