# -*- coding: utf-8 -*-
# (c) The James Hutton Institute 2016-2019
# (c) University of Strathclyde 2019-2022
# Author: Leighton Pritchard
#
# Contact:
# leighton.pritchard@strath.ac.uk
#
# Leighton Pritchard,
# Strathclyde Institute for Pharmacy and Biomedical Sciences,
# Cathedral Street,
# Glasgow,
# G4 0RE
# Scotland,
# UK
#
# The MIT License
#
# Copyright (c) 2016-2019 The James Hutton Institute
# Copyright (c) 2019-2022 University of Strathclyde
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""Provides parser for report subcommand."""
from argparse import ArgumentDefaultsHelpFormatter, ArgumentParser, _SubParsersAction
from pathlib import Path
from typing import List, Optional
from pyani.scripts import subcommands
[docs]def build(
subps: _SubParsersAction, parents: Optional[List[ArgumentParser]] = None
) -> None:
"""Return a command-line parser for the report subcommand.
:param subps: collection of subparsers in main parser
:param parents: parsers from which arguments are inherited
"""
parser = subps.add_parser(
"report", parents=parents, formatter_class=ArgumentDefaultsHelpFormatter
)
# Required argument: output directory
parser.add_argument(
"-o",
"--outdir",
action="store",
dest="outdir",
default=None,
type=Path,
help="output analysis results directory",
required=True,
)
# Optional arguments
parser.add_argument(
"--dbpath",
action="store",
dest="dbpath",
default=Path(".pyani/pyanidb"),
type=Path,
help="path to pyani database",
)
parser.add_argument(
"--runs",
action="store_true",
dest="show_runs",
default=False,
help="Report table of analysis runs in database",
)
parser.add_argument(
"--genomes",
action="store_true",
dest="show_genomes",
default=False,
help="Report table of genomes in database",
)
parser.add_argument(
"--runs_genomes",
action="store_true",
dest="show_runs_genomes",
default=False,
help="Report table of all genomes for each run in database",
)
parser.add_argument(
"--genomes_runs",
action="store_true",
dest="show_genomes_runs",
default=False,
help="Report table of all runs in which each genome in the database participates",
)
parser.add_argument(
"--run_results",
action="store",
dest="run_results",
metavar="RUN_ID",
nargs="+",
default=None,
help="Report table of results for space-separated list of runs",
)
parser.add_argument(
"--run_matrices",
action="store",
dest="run_matrices",
metavar="RUN_ID",
nargs="+",
default=None,
help="Report matrices of results for space-separated list of runs",
)
parser.add_argument(
"--no_matrix_labels",
action="store_true",
dest="no_matrix_labels",
default=False,
help="Turn off row/column labels in output matrix files",
)
parser.add_argument(
"--formats",
dest="formats",
action="store",
default=None,
metavar="FORMAT",
nargs="+",
choices=("html", "excel", "stdout"),
help="Space-separated list of output formats (in addition to .tab); possible values: {html, excel, stdout}",
)
parser.set_defaults(func=subcommands.subcmd_report)