craw_htmp¶
craw_htmp.py is the entry point script to compute heatmap.
-
craw.scripts.craw_htmp._file_readable(value)[source]¶ check value given by the parser
- Parameters
value (str) – the value given by the parser for –sort-using-file option
- Returns
the normpath of the value
- Raises
ArgumentError if the file does not exists, or is not a file, or not readable
-
craw.scripts.craw_htmp._gene_size_parser(value)[source]¶ Parse value given by the parser
- Parameters
value (string) – the value given by the parser for –sort-by-gene-size option
- Returns
name of column representing the start of gene, name of the column representing the end of gene
- Return type
tuple of 2 string
- Raise
argparse.ArgumentErrorobject if value cannot be parsed
-
craw.scripts.craw_htmp._size_fig_parser(value)[source]¶ Parse value given by the parser for –size option the value must follow the syntax widexheight[unit] if the unit is omitted unit is inch otherwise unit must be
‘mm’ for millimeters
‘cm’ for centimeters
‘in’ for inches
‘px’ for pixels
wide and height must be positive integers.
- Parameters
value (string) – the size of the figure
- Returns
the size in inch ask by the user
- Return type
tuple of float
- Raise
argparse.ArgumentErrorobject
-
craw.scripts.craw_htmp.get_version_message()[source]¶ - Returns
a human readable of craw_htmp version and it’s main dependencies.
- Return type
str
-
craw.scripts.craw_htmp.main(args=None, log_level=None, logger_out=True)[source]¶ The entrypoint for craw_html script
It will generate a heatmap representing the coverage matrix around the position of interest it can display the results on the screen or write it on file depending the options
- Parameters
args (list of string) – The arguments and option representing the command line
log_level – the level of verbosity
logger_out – True if you want to display logs on stdout, False otherwise
- Returns