annotate lexmapr2.py @ 4:819eff1bd7ac tip

"planemo upload"
author cstrittmatter
date Wed, 29 Jun 2022 15:30:52 -0400
parents f298f3e5c515
children
rev   line source
cstrittmatter@0 1 """Entry script"""
cstrittmatter@0 2
cstrittmatter@0 3 __version__ = '1.0.0'
cstrittmatter@0 4 import argparse, datetime, json, logging, os, pandas, sys
cstrittmatter@0 5 import lexmapr.pipeline, lexmapr.run_summary
cstrittmatter@0 6 from lexmapr.definitions import arg_bins
cstrittmatter@0 7
cstrittmatter@0 8
cstrittmatter@0 9 def valid_input(file_path):
cstrittmatter@0 10 '''Exits if input file is invalid'''
cstrittmatter@0 11 _, file_ext = os.path.splitext(file_path)
cstrittmatter@0 12 if file_ext.lower() != '.csv' and file_ext.lower() != '.tsv':
cstrittmatter@0 13 sys.exit('Please supply a CSV or TSV input file with the correct file extension')
cstrittmatter@0 14 if not os.path.exists(file_path):
cstrittmatter@0 15 sys.exit(f'Input file named \"{file_path}\" not found')
cstrittmatter@0 16 return(file_path.strip())
cstrittmatter@0 17
cstrittmatter@0 18 def valid_json(file_path):
cstrittmatter@0 19 '''Outputs read JSON file and exits if file is invalid'''
cstrittmatter@0 20 try:
cstrittmatter@0 21 with open(file_path, 'r') as JSON_file:
cstrittmatter@0 22 try:
cstrittmatter@0 23 return(json.load(JSON_file))
cstrittmatter@0 24 except(json.decoder.JSONDecodeError):
cstrittmatter@0 25 sys.exit(f'User-defined bins not in readable JSON format')
cstrittmatter@0 26 except(FileNotFoundError):
cstrittmatter@0 27 sys.exit(f'File named \"{file_path}\" not found')
cstrittmatter@0 28
cstrittmatter@0 29 def valid_list(list_str):
cstrittmatter@0 30 '''Return list of user-defined ontologies'''
cstrittmatter@0 31 return([x.strip().upper() for x in list_str.split(',')])
cstrittmatter@0 32
cstrittmatter@0 33 if __name__ == "__main__":
cstrittmatter@0 34 # Parse arguments, initiate log file and start run
cstrittmatter@0 35 arg_parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
cstrittmatter@0 36 arg_parser.add_argument('input', help='input CSV or TSV file; required', type=valid_input)
cstrittmatter@0 37 arg_parser.add_argument('-o', '--output', metavar='\b',
cstrittmatter@0 38 help=' output TSV file path; default is stdout')
cstrittmatter@0 39 arg_parser.add_argument('-a', '--no_ancestors', action='store_true',
cstrittmatter@0 40 help='remove ancestral terms from output')
cstrittmatter@0 41 arg_parser.add_argument('-b', '--bin', action='store_true',
cstrittmatter@0 42 help='classify samples into default bins')
cstrittmatter@0 43 arg_parser.add_argument('-e', '--embl_ontol', metavar='\b', type=valid_list,
cstrittmatter@0 44 help=' user-defined comma-separated ontology short names')
cstrittmatter@0 45 arg_parser.add_argument('-f', '--full', action='store_true', help='full output format')
cstrittmatter@0 46 arg_parser.add_argument('-g', '--graph', action='store_true',
cstrittmatter@0 47 help='visualize summaries of mapping and binning')
cstrittmatter@0 48 arg_parser.add_argument('-j', '--graph_only', action='store_true',
cstrittmatter@0 49 help='only perform visualization with LexMapr output')
cstrittmatter@0 50 arg_parser.add_argument('-r', '--remake_cache', action='store_true',
cstrittmatter@0 51 help='remake cached resources')
cstrittmatter@0 52 arg_parser.add_argument('-u', '--user_bin', metavar='\b', type=valid_json,
cstrittmatter@0 53 help=' path to JSON file with user-defined bins')
cstrittmatter@0 54 arg_parser.add_argument('-v', '--version', action='version',
cstrittmatter@0 55 version='%(prog)s '+__version__)
cstrittmatter@0 56
cstrittmatter@0 57 # TODO: encoding argument addded to logging.basicConfig in Python 3.9; now defaults to open()
cstrittmatter@0 58 run_args = arg_parser.parse_args()
cstrittmatter@0 59 if run_args.user_bin is not None:
cstrittmatter@0 60 run_args.bin = True
cstrittmatter@0 61 arg_bins = run_args.user_bin
cstrittmatter@0 62
cstrittmatter@0 63 logging.basicConfig(filename='lexmapr_run.log', level=logging.DEBUG)
cstrittmatter@0 64
cstrittmatter@0 65 if run_args.graph_only:
cstrittmatter@0 66 try:
cstrittmatter@0 67 mapping_results = pandas.read_csv(run_args.input, delimiter='\t')
cstrittmatter@0 68 except:
cstrittmatter@0 69 sys.exit('Input file not readable or not in expected format')
cstrittmatter@0 70 needed_columns = ['Matched_Components','Match_Status (Macro Level)']+list(arg_bins.keys())
cstrittmatter@0 71 missing_columns = set(needed_columns).difference(set(mapping_results.columns))
cstrittmatter@0 72 if missing_columns:
cstrittmatter@0 73 sys.exit(f'Missing column(s) {missing_columns} from input file')
cstrittmatter@0 74 t0 = datetime.datetime.now()
cstrittmatter@0 75 logging.info(f'Run start: {t0}')
cstrittmatter@0 76 logging.info('Graphing only')
cstrittmatter@0 77 print('\nGraphing only...')
cstrittmatter@0 78 lexmapr.run_summary.figure_folder()
cstrittmatter@0 79 lexmapr.run_summary.report_results(run_args.input, list(arg_bins.keys()))
cstrittmatter@0 80 lexmapr.run_summary.visualize_results(run_args.input, list(arg_bins.keys()))
cstrittmatter@0 81 print('\t'+f'Done! {datetime.datetime.now()-t0} passed'.ljust(60)+'\n')
cstrittmatter@0 82 else:
cstrittmatter@0 83 logging.info(f'Run start: {datetime.datetime.now()}')
cstrittmatter@0 84 lexmapr.pipeline.run(run_args)
cstrittmatter@0 85
cstrittmatter@0 86 logging.info(f'Run end: {datetime.datetime.now()}\n')