jdidion / atropos

An NGS read trimming tool that is specific, sensitive, and speedy. (production)
Other
119 stars 15 forks source link

defaults not listed in cli docs #130

Open nick-youngblut opened 2 years ago

nick-youngblut commented 2 years ago

For much of the cli help docs, the defaults are not included. For example:

Heuristic Detector Options:
  --min-frequency MIN_FREQUENCY
                        Minimum frequency required to retain a k-mer.
  --min-contaminant-match-frac MIN_CONTAMINANT_MATCH_FRAC
                        Minimum fraction of nucleotides that must align for a
                        detected contaminant to match a known adapter
                        sequence.

Why now use an argparse formatter that automatically lists the defaults? For example:

class CustomFormatter(argparse.ArgumentDefaultsHelpFormatter,
                      argparse.RawDescriptionHelpFormatter):
    pass

parser = argparse.ArgumentParser(description=desc, formatter_class=CustomFormatter)