cadbiom_cmd.py 21.6 KB
Newer Older
1
# -*- coding: utf-8 -*-
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Copyright (C) 2017  IRISA
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# The original code contained here was initially developed by:
#
#     Pierre Vignet.
#     IRISA
#     Dyliss team
#     IRISA Campus de Beaulieu
#     35042 RENNES Cedex, FRANCE
24
"""Entry point and argument parser for cadbiom_cmd package"""
25
26
27
from __future__ import unicode_literals
from __future__ import print_function

28
29
30
# Standard imports
import argparse
import os
31
import sys
32

33
# Custom imports
34
import cadbiom.commons as cm
35

36
37
LOGGER = cm.logger()

38
39
40
def solutions_search(args):
    """Launch the search for Minimum Activation Conditions (MAC) for entities
    of interest.
41
42
    """

43
44
    # Module import
    import solution_search
45
    params = args_to_param(args)
46
    solution_search.solutions_search(params) # !
47

48

49
def solutions_sort(args):
VIGNET Pierre's avatar
VIGNET Pierre committed
50
    """Read a solution file or a directory containing MAC solutions files
51
    (*mac* files), and sort all frontier places/boundaries in alphabetical order.
52
53
    """

54
55
    # Module import
    import solution_sort
56
    params = args_to_param(args)
57
    solution_sort.solutions_sort(params['path'])
58

59

60
def solutions_2_graph(args):
61
    """Create GraphML formated files containing a representation of the
62
    trajectories for every solution in complete MAC files (*mac_complete files).
63
64
65

    This is a function to visualize paths taken by the solver from the boundaries
    to the entities of interest.
66
67
    """

68
    # Module import
69
    import solution_sort
70
    params = args_to_param(args)
71
    solution_sort.solutions_2_graph(
72
73
        params['output'],
        params['chart_file'],
74
        params['path']
75
    )
76

77

78
def solutions_2_json(args):
79
    """Create a JSON formated file containing all data from complete MAC files
80
    (*mac_complete files). The file will contain frontier places/boundaries
81
    and decompiled steps with their respective events for each solution.
82
83
84
85
86
87

    This is a function to quickly search all transition attributes involved
    in a solution.
    """

    # Module import
88
    import solution_sort
89
    params = args_to_param(args)
90
    solution_sort.solutions_2_json(
91
92
        params['output'],
        params['chart_file'],
93
        params['path'],
94
        conditions=not params['no_conditions'], # Reverse the param...
95
    )
96

97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

def json_2_interaction_graph(args):
    """Make an interaction weighted graph based on the searched molecule of interest.

    Read decompiled solutions files (*.json* files produced by the
    directive 'solutions_2_json') and make a graph of the relationships
    between one or more molecules of interest, the genes and other
    frontier places/boundaries found among all the solutions.
    """

    # Module import
    import interaction_graph
    params = args_to_param(args)
    interaction_graph.json_2_interaction_graph(
        params['output'],
        params['molecules_of_interest'],
        params['path'],
    )


117
118
def solutions_2_common_graph(args):
    """Create a GraphML formated file containing a representation of **all**
119
    trajectories for **all** solutions in complete MAC files (*mac_complete files).
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

    This is a function to visualize paths taken by the solver from the boundaries
    to the entities of interest.
    """

    # Module import
    import solution_sort
    params = args_to_param(args)
    solution_sort.solutions_2_common_graph(
        params['output'],
        params['chart_file'],
        params['path']
    )


VIGNET Pierre's avatar
VIGNET Pierre committed
135
136
def solutions_2_occcurrences_matrix(args):
    """Create a matrix of occurrences counting entities in the solutions found in
137
    *mac.txt files in the given path.
VIGNET Pierre's avatar
VIGNET Pierre committed
138
139
140
141
142
143
144
145
146
147
148
149
    """

    # Module import
    import solution_sort
    params = args_to_param(args)
    solution_sort.solutions_2_occcurrences_matrix(
        params['output'],
        params['chart_file'],
        params['path'],
        transposed=params['transpose_csv']
    )

150
151
152
153
154
155
156
157
158
159
160
161
162
163

def identifiers_mapping(args):
    """Mapping of identifiers from external databases.

    This function exports a CSV formated file presenting the list of known
    Cadbiom identifiers for each given external identifier.
    """

    # Module import
    import solution_repr
    params = args_to_param(args)
    solution_repr.identifiers_mapping(**params)


164
165
def model_comparison(args):
    """Isomorphism test.
166

167
168
    Check if the graphs based on the two given models have  the same topology,
    nodes & edges attributes/roles.
169
170
171
172
173
    """

    # Module import
    import solution_repr
    params = args_to_param(args)
174
175
    params['output'] = params['output'] if params['output'][-1] == '/' \
                        else params['output'] + '/'
176
177
178
    solution_repr.graph_isomorph_test(
        params['model_file_1'],
        params['model_file_2'],
179
        params['output'],
180
181
        params['graphs'],
        params['json'],
182
183
184
    )


185
186
187
def model_info(args):
    """Provide several levels of information about the structure of the model
    and its places/entities.
188
189
190
191
192
    """

    # Module import
    import solution_repr
    params = args_to_param(args)
193
194

    params['output_dir'] = params['output'] if params['output'][-1] == '/' \
195
                        else params['output'] + '/'
196
    solution_repr.model_info(**params)
197
198
199


def model_graph(args):
200
    """Information about the graph based on the model.
201
202

    Get centralities (degree, in_degree, out_degree, closeness, betweenness).
203
    Forge a GraphML file.
204
205
206
207
208
209
210
211
    """

    # Module import
    import solution_repr
    params = args_to_param(args)
    params['output_dir'] = params['output'] if params['output'][-1] == '/' \
                        else params['output'] + '/'
    solution_repr.model_graph(**params)
212
213


214
def merge_macs(args):
215
    """Merge solutions to a csv file."""
216
217
218

    # Module import
    import solution_merge
219
    params = args_to_param(args)
220
    solution_merge.merge_macs_to_csv(params['solutions_directory'],
221
                                     params['output'])
222
223


224
225
226
227
228
def args_to_param(args):
    """Return argparse namespace as a dict {variable name: value}"""
    return {k: v for k, v in vars(args).items() if k != 'func'}


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
class ReadableFile(argparse.Action):
    """
    http://stackoverflow.com/questions/11415570/directory-path-types-with-argparse
    """

    def __call__(self, parser, namespace, values, option_string=None):
        prospective_file = values

        if not os.path.isfile(prospective_file):
            raise argparse.ArgumentTypeError(
                "readable_file:{0} is not a valid path".format(
                    prospective_file)
                )

        if os.access(prospective_file, os.R_OK):
            setattr(namespace, self.dest, prospective_file)
        else:
            raise argparse.ArgumentTypeError(
                "readable_file:{0} is not a readable file".format(
                    prospective_file)
                )


class ReadableDir(argparse.Action):
253
254
255
256
257
258
259
260
261
    """
    http://stackoverflow.com/questions/11415570/directory-path-types-with-argparse
    """

    def __call__(self, parser, namespace, values, option_string=None):
        prospective_dir = values

        if not os.path.isdir(prospective_dir):
            raise argparse.ArgumentTypeError(
262
263
264
                "readable_dir:{0} is not a valid path".format(
                    prospective_dir)
                )
265
266
267
268
269

        if os.access(prospective_dir, os.R_OK):
            setattr(namespace, self.dest, prospective_dir)
        else:
            raise argparse.ArgumentTypeError(
270
271
272
                "readable_dir:{0} is not a readable dir".format(
                    prospective_dir)
                )
273
274


275
def main():
276
    """Argument parser"""
277
278
279
280

    # parser configuration
    parser = argparse.ArgumentParser(description=__doc__)
    # Default log level: debug
VIGNET Pierre's avatar
VIGNET Pierre committed
281
    parser.add_argument('-vv', '--verbose', nargs='?', default='info')
282
283
284
    # Subparsers
    subparsers = parser.add_subparsers(title='subcommands')

285
    # PS: nargs='?' = optional
286
287
288
289
290
    # subparser: Compute macs
    #    steps      = 10
    #    final_prop = "P"
    #    start_prop = None
    #    inv_prop   = None
291
    parser_input_file = subparsers.add_parser(
292
293
        'solutions_search',
        help=solutions_search.__doc__,
294
295
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )
296
    parser_input_file.add_argument('chart_file')
VIGNET Pierre's avatar
VIGNET Pierre committed
297
    # Get final_property alone OR an input_file containing multiple properties
298
    group = parser_input_file.add_mutually_exclusive_group(required=True)
299
    group.add_argument('final_prop', nargs='?')
300
    group.add_argument('--input_file', action=ReadableFile, nargs='?',
301
302
303
        help="Without input file, there will be only one process. "
             "While there will be 1 process per line (per logical formula "
             "on each line)")
304
    parser_input_file.add_argument('--output', action=ReadableDir, nargs='?',
VIGNET Pierre's avatar
VIGNET Pierre committed
305
                                   default='result/', help="Output directory.")
306

307
    # default: False
308
    parser_input_file.add_argument('--combinations', action='store_true',
309
310
        help="If input_file is set, we can compute all combinations of "
             "given elements on each line")
311
312
    parser_input_file.add_argument('--steps', type=int, nargs='?', default=10,
        help="Maximum of allowed steps to find macs")
313
314
    parser_input_file.add_argument('--limit', type=int, nargs='?', default=400,
        help="Limit the number of solutions.")
315
    # https://docs.python.org/dev/library/argparse.html#action
316
    # all_macs to False by default
317
    parser_input_file.add_argument('--all_macs', action='store_true',
318
319
        help="Solver will try to search all macs with 0 to the maximum of "
             "allowed steps.")
VIGNET Pierre's avatar
VIGNET Pierre committed
320
    # continue to False by default
321
    parser_input_file.add_argument('--continue', action='store_true',
322
323
        help="Resume previous computations; if there is a mac file from a "
             "previous work, last frontier places/boundaries will be reloaded.")
324
325
    parser_input_file.add_argument('--start_prop', nargs='?', default=None)
    parser_input_file.add_argument('--inv_prop', nargs='?', default=None)
326

327
    parser_input_file.set_defaults(func=solutions_search)
328

329
    ## Solutions-related commands ##############################################
330
331
332

    # subparser: Sort solutions in alphabetical order in place
    # Solution file (complete or not)
333
334
    parser_solutions_sort = subparsers.add_parser('solutions_sort',
                                                  help=solutions_sort.__doc__)
335
    parser_solutions_sort.add_argument('path',
336
        help="Solution file or directory with MAC solutions files "
337
             "(*mac* files) generated with the 'solutions_search' command.")
338
    parser_solutions_sort.set_defaults(func=solutions_sort)
339
340
341
342


    # subparser: Representation of the trajectories of MACs in a complete file.
    # Model file (xml : cadbiom language)
343
    # Solution file (mac_complete)
344
    parser_trajectories = subparsers.add_parser(
345
346
        'solutions_2_graph',
        help=solutions_2_graph.__doc__,
347
348
349
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser_trajectories.add_argument('chart_file',
        help="bcx model file.")
350
    parser_trajectories.add_argument('path',
351
        help="Complete solution file or directory with MAC solutions files "
352
             "(*mac_complete.txt files) generated with the 'compute_macs' command.")
353
    parser_trajectories.add_argument('--output', action=ReadableDir,
354
        nargs='?', default='graphs/',
355
        help="Output directory for GraphML files.")
356
    parser_trajectories.set_defaults(func=solutions_2_graph)
357
358


359
    # subparser: Decompilation of trajectories of MACs in a complete file/dir.
360
    # Model file (xml : cadbiom language)
361
    # Solution file (mac_complete)
362
363
364
    parser_solutions_2_json = subparsers.add_parser(
        'solutions_2_json',
        help=solutions_2_json.__doc__,
365
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
366
    parser_solutions_2_json.add_argument('chart_file',
367
        help="bcx model file.")
368
369
    parser_solutions_2_json.add_argument('path',
        help="Complete solution file or directory with MAC solutions files "
370
             "(*mac_complete.txt files) generated with the 'compute_macs' command.")
371
    parser_solutions_2_json.add_argument('--output', action=ReadableDir,
372
        nargs='?', default='decompiled_solutions/',
373
        help="Directory for newly created files.")
374
375
    parser_solutions_2_json.add_argument('--no_conditions', action='store_true',
        help="Don't export conditions of transitions. This allows "
376
377
             "to have only places/entities that are used inside trajectories; "
             "thus, inhibitors nodes are not present in the json file")
378
    parser_solutions_2_json.set_defaults(func=solutions_2_json)
379
380


381
382
383
384
385
386
387
    # subparser: Make an interaction weighted graph based on the searched
    # molecule of interest
    # Require JSON decompilated solutions files
    parser_json_2_interaction_graph = subparsers.add_parser(
        'json_2_interaction_graph',
        help=json_2_interaction_graph.__doc__,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
VIGNET Pierre's avatar
VIGNET Pierre committed
388
    parser_json_2_interaction_graph.add_argument('molecules_of_interest', nargs='+',
389
390
391
392
393
        help="One or multiple molecule of interest to search in the trajectories"
             " of every solutions")
    parser_json_2_interaction_graph.add_argument('--path',
        nargs='?', default='decompiled_solutions/',
        help="JSON formated file containing all data from complete MAC files"
394
             "(*mac_complete files) generated with the 'solutions_2_json' command.")
395
396
397
398
399
400
    parser_json_2_interaction_graph.add_argument('--output', action=ReadableDir,
        nargs='?', default='graphs/',
        help="Directory for the newly created file.")
    parser_json_2_interaction_graph.set_defaults(func=json_2_interaction_graph)


401
402
    # subparser: Common representation of the trajectories of MACs in a complete file.
    # Model file (xml : cadbiom language)
403
    # Solution file (mac_complete)
404
405
406
407
408
409
410
411
    parser_trajectories = subparsers.add_parser(
        'solutions_2_common_graph',
        help=solutions_2_common_graph.__doc__,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser_trajectories.add_argument('chart_file',
        help="bcx model file.")
    parser_trajectories.add_argument('path',
        help="Complete solution file or directory with MAC solutions files "
412
             "(*mac_complete.txt files) generated with the 'compute_macs' command.")
413
414
415
416
417
418
    parser_trajectories.add_argument('--output', action=ReadableDir,
        nargs='?', default='graphs/',
        help="Output directory for GraphML files.")
    parser_trajectories.set_defaults(func=solutions_2_common_graph)


VIGNET Pierre's avatar
VIGNET Pierre committed
419
420
    # subparser: Create a matrix of occurrences counting entities in the solutions.
    # Model file (xml : cadbiom language)
421
    # Solution file (mac.txt)
VIGNET Pierre's avatar
VIGNET Pierre committed
422
423
424
425
426
427
428
429
    parser_occurrences_matrix = subparsers.add_parser(
        'solutions_2_occcurrences_matrix',
        help=solutions_2_occcurrences_matrix.__doc__,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser_occurrences_matrix.add_argument('chart_file',
        help="bcx model file.")
    parser_occurrences_matrix.add_argument('path',
        help="Directory with MAC solutions files "
430
             "(*mac.txt files) generated with the 'compute_macs' command.")
VIGNET Pierre's avatar
VIGNET Pierre committed
431
432
433
434
435
436
437
438
    parser_occurrences_matrix.add_argument('--output', action=ReadableDir,
        nargs='?', default='./',
        help="Output directory for CSV files.")
    parser_occurrences_matrix.add_argument('--transpose_csv', action='store_true',
        help="Transpose the final matrix (switch columns and rows).")
    parser_occurrences_matrix.set_defaults(func=solutions_2_occcurrences_matrix)


439
    # subparser: Merge solutions to a csv file
440
    # Solution file (mac)
441
    # Output (csv)
442
443
444
    parser_merge_macs = subparsers.add_parser(
        'merge_macs',
        help=merge_macs.__doc__,
445
446
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )
447
    parser_merge_macs.add_argument('solutions_directory', nargs='?',
448
        default='result/')
449
450
451
452
    parser_merge_macs.add_argument('--output', nargs='?',
        default='result/merged_macs.csv',
        help="CSV file: <Final property formula>;<mac>")
    parser_merge_macs.set_defaults(func=merge_macs)
453

454
    ## Model-related commands ##################################################
455

456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
    # subparser: Mapping of identifiers
    # output: CSV file
    parser_identifiers_mapping = subparsers.add_parser(
        'identifiers_mapping',
        help=identifiers_mapping.__doc__,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )
    parser_identifiers_mapping.add_argument('model_file',
        help="bcx model file.")
    group = parser_identifiers_mapping.add_mutually_exclusive_group(required=True)
    group.add_argument('--external_file',
        help="File with 1 external identifiers to be mapped per line."
    )
    group.add_argument('--external_identifiers', nargs='+',
        help="Multiple external identifiers to be mapped."
    )
    parser_identifiers_mapping.set_defaults(func=identifiers_mapping)


475
476
    # subparser: Model comparison
    # 2 models
477
    parser_model_comparison = subparsers.add_parser(
478
479
        'model_comparison',
        help=model_comparison.__doc__,
480
481
482
483
484
485
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )
    parser_model_comparison.add_argument('model_file_1',
        help="bcx model file.")
    parser_model_comparison.add_argument('model_file_2',
        help="bcx model file.")
486
    # Export graphs for the 2 models; default: false
487
    parser_model_comparison.add_argument('--graphs', action='store_true',
488
        help="Create two GraphML files from the given models.")
489
490
    parser_model_comparison.add_argument('--json', action='store_true',
        help="Create a summary dumped into a json file.")
491
    parser_model_comparison.add_argument('--output', action=ReadableDir,
492
493
        nargs='?', default='graphs/',
        help="Directory for created graphs files.")
494
    parser_model_comparison.set_defaults(func=model_comparison)
495
496


497
498
    # subparser: Model infos
    # 1 model
499
500
501
    parser_model_info = subparsers.add_parser(
        'model_info',
        help=model_info.__doc__,
502
503
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )
504
    parser_model_info.add_argument('model_file')
505
    # Filters
506
507
    group = parser_model_info.add_mutually_exclusive_group(required=True)
    # PS: Argparse doesn't allow to select a default value here
508
509
    group.add_argument('--default', action='store_true',
        help="Display quick description of the model "
510
             "(Number of places/entities, transitions, entity types, locations)")
511
512
513
514
    group.add_argument('--all_entities', action='store_true',
        help="Retrieve data for all places/entities of the model.")
    group.add_argument('--boundaries', action='store_true',
        help="Retrieve data only for the frontier places/boundaries of the model.")
515
516
517
    group.add_argument('--genes', action='store_true',
        help="Retrieve data only for the genes in the model.")
    # Outputs
518
519
    parser_model_info.add_argument('--csv', action='store_true',
        help="Create a CSV file containing data about previously filtered "
520
             "places/entities of the model.")
521
522
    parser_model_info.add_argument('--json', action='store_true',
        help="Create a JSON formated file containing data about previously "
523
524
525
             "filtered places/entities of the model, and a full summary about the "
             "model itself (boundaries, transitions, events, entities locations,"
             " entities types).")
526
    parser_model_info.add_argument('--output', action=ReadableDir,
527
528
        nargs='?', default='./',
        help="Directory for newly created files.")
529
    parser_model_info.set_defaults(func=model_info)
530

531
532
533
534
535
536
537
538
539

    # subparser: Model graph
    parser_model_graph = subparsers.add_parser(
        'model_graph',
        help=model_graph.__doc__,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )
    parser_model_graph.add_argument('model_file')
    # Additional data
540
    parser_model_graph.add_argument('--centralities', action='store_true',
VIGNET Pierre's avatar
VIGNET Pierre committed
541
        help="Get centralities for each node of the graph "
542
543
             "(degree, in_degree, out_degree, closeness, betweenness). "
             "Works in conjunction with the ``--json`` option.")
544
545
    # Outputs
    parser_model_graph.add_argument('--graph', action='store_true',
546
        help="Translate the model into a GraphML formated file which can "
547
             "be opened in Cytoscape.")
548
    parser_model_graph.add_argument('--json', action='store_true',
549
        help="Create a JSON formated file containing a summary of the graph "
550
             "based on the model.")
VIGNET Pierre's avatar
VIGNET Pierre committed
551
552
    parser_model_graph.add_argument('--json_graph', action='store_true',
        help="Create a JSON formated file containing the graph based on the "
553
             "model, which can be opened by Web applications.")
554
555
    parser_model_graph.add_argument('--output', action=ReadableDir,
        nargs='?', default='graphs/',
VIGNET Pierre's avatar
VIGNET Pierre committed
556
        help="Directory for newly created files.")
557
558
559
    parser_model_graph.set_defaults(func=model_graph)


560
561
562
563
    # Workaround for sphinx-argparse module that require the object parser
    # before the call of parse_args()
    if 'html' in sys.argv:
        return parser
564

565
566
    # get program args and launch associated command
    args = parser.parse_args()
567

568
    # Set log level
569
570
    cm.log_level(vars(args)['verbose'])

571
572
    # launch associated command
    args.func(args)