[med-svn] [Git][med-team/megadepth][master] 2 commits: Tailor manpage manually, remove help2man automation
Nilesh Patra (@nilesh)
gitlab at salsa.debian.org
Mon Jul 11 19:05:09 BST 2022
Nilesh Patra pushed to branch master at Debian Med / megadepth
Commits:
985b6556 by Nilesh Patra at 2022-07-11T17:58:24+00:00
Tailor manpage manually, remove help2man automation
- - - - -
ec58125a by Nilesh Patra at 2022-07-11T23:29:47+05:30
Upload to unstable
- - - - -
6 changed files:
- debian/changelog
- debian/control
- + debian/createmanpages
- debian/manpages
- + debian/megadepth.1
- debian/rules
Changes:
=====================================
debian/changelog
=====================================
@@ -1,11 +1,15 @@
-megadepth (1.2.0-3) UNRELEASED; urgency=medium
+megadepth (1.2.0-3) unstable; urgency=medium
+ [ Mohammed Bilal ]
* Team upload.
* Add autopkgtests
* routine-update: Packaging update
* routine-update: Standards-Version: 4.6.1
+
+ [ Nilesh Patra ]
+ * Tailor manpage manually, remove help2man automation
- -- Mohammed Bilal <mdbilal at disroot.org> Mon, 11 Jul 2022 17:02:29 +0000
+ -- Nilesh Patra <nilesh at debian.org> Mon, 11 Jul 2022 23:29:37 +0530
megadepth (1.2.0-2) unstable; urgency=medium
=====================================
debian/control
=====================================
@@ -7,8 +7,7 @@ Build-Depends: debhelper-compat (= 13),
cmake,
libhts-dev,
libdeflate-dev,
- libbigwig-dev,
- help2man
+ libbigwig-dev
Standards-Version: 4.6.1
Homepage: https://github.com/ChristopherWilks/megadepth
Vcs-Browser: https://salsa.debian.org/med-team/megadepth
=====================================
debian/createmanpages
=====================================
@@ -0,0 +1,51 @@
+#!/bin/sh
+
+set -e
+
+if [ ! -x /usr/bin/help2man ]; then
+ echo "E: Missing /usr/bin/help2man, please install it from the cognate package."
+ exit 1
+fi
+
+if [ ! -n "$NAME" ]; then
+ NAME=`grep "^Description:" debian/control | sed 's/^Description: *//' | head -n1`
+fi
+
+if [ ! -n "$VERSION" ]; then
+ VERSION=`dpkg-parsechangelog | awk '/^Version:/ {print $2}' | sed -e 's/^[0-9]*://' -e 's/-.*//' -e 's/[+~]dfsg$//'`
+fi
+
+if [ ! -n "$PROGNAME" ]; then
+ PROGNAME=`grep "^Package:" debian/control | sed 's/^Package: *//' | head -n1`
+fi
+
+MANDIR=debian
+HELPOPTION=--help
+NAME="Quantification of genome coverage by DNA/RNA seqencing"
+
+echo "PROGNAME: '$PROGNAME'"
+echo "NAME: '$NAME'"
+echo "VERSION: '$VERSION'"
+echo "MANDIR: '$MANDIR'"
+echo "HELPOPTION: '$HELPOPTION'"
+
+mkdir -p $MANDIR
+
+
+# If program name is different from package name or title should be
+# different from package short description change this here
+progname=${PROGNAME}
+help2man --no-info --no-discard-stderr --help-option="$HELPOPTION" \
+ --name="$NAME" \
+ --version-string="$VERSION" ${progname} > $MANDIR/${progname}.1
+
+echo "$MANDIR/*.1" > debian/manpages
+
+cat <<EOT
+Please enhance the help2man output in '$MANDIR/${progname}.1'.
+To inspect it, try 'nroff -man $MANDIR/${progname}.1'.
+If very unhappy, try passing the HELPOPTION as an environment variable.
+The following web page might be helpful in doing so:
+ http://liw.fi/manpages/
+EOT
+
=====================================
debian/manpages
=====================================
@@ -1 +1 @@
-debian/megadepth.1
+debian/*.1
=====================================
debian/megadepth.1
=====================================
@@ -0,0 +1,186 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
+.TH MEGADEPTH "1" "July 2022" "megadepth 1.2.0" "User Commands"
+.SH NAME
+megadepth \- Quantification of genome coverage by DNA/RNA seqencing
+.SH DESCRIPTION
+megadepth 1.2.0
+.PP
+BAM and BigWig utility.
+.SS "Usage:"
+.IP
+megadepth <bam|bw|\-> [options]
+.SH OPTIONS
+.TP
+\fB\-h\fR \fB\-\-help\fR
+Show this screen.
+.TP
+\fB\-\-version\fR
+Show version.
+.TP
+\fB\-\-threads\fR
+# of threads to do: BAM decompression OR compute sums over multiple BigWigs in parallel
+if the 2nd is intended then a TXT file listing the paths to the BigWigs to process in parallel
+should be passed in as the main input file instead of a single BigWig file (EXPERIMENTAL).
+.TP
+\fB\-\-prefix\fR
+String to use to prefix all output files.
+.TP
+\fB\-\-no\-auc\-stdout\fR
+Force all AUC(s) to be written to <prefix>.auc.tsv rather than STDOUT
+.TP
+\fB\-\-no\-annotation\-stdout\fR
+Force summarized annotation regions to be written to <prefix>.annotation.tsv rather than STDOUT
+.TP
+\fB\-\-no\-coverage\-stdout\fR
+Force covered regions to be written to <prefix>.coverage.tsv rather than STDOUT
+.TP
+\fB\-\-keep\-order\fR
+Output annotation coverage in the order chromosomes appear in the BAM/BigWig file
+The default is to output annotation coverage in the order chromosomes appear in the annotation BED file.
+This is only applicable if \fB\-\-annotation\fR is used for either BAM or BigWig input.
+.PP
+BigWig Input:
+Extract regions and their counts from a BigWig outputting BED format if a BigWig file is detected as input (exclusive of the other BAM modes):
+.TP
+Extracts all reads from the passed in BigWig and output as BED format.
+This will also report the AUC over the annotated regions to STDOUT.
+If only the name of the BigWig file is passed in with no other args, it will *only* report total AUC to STDOUT.
+.TP
+\fB\-\-annotation\fR <bed>
+Only output the regions in this BED applying the argument to \fB\-\-op\fR to them.
+.TP
+\fB\-\-op\fR <sum[default], mean, min, max>
+Statistic to run on the intervals provided by \fB\-\-annotation\fR
+.TP
+\fB\-\-sums\-only\fR
+Discard coordinates from output of summarized regions
+.TP
+\fB\-\-distance\fR (2200[default])
+Number of base pairs between end of last annotation and start of new to consider in the same BigWig query window (a form of binning) for performance. This determines the number of times the BigWig index is queried.
+.TP
+\fB\-\-unsorted\fR (off[default])
+There's a performance improvement *if* BED file passed to \fB\-\-annotation\fR is 1) sorted by sort \fB\-k1\fR,1 \fB\-k2\fR,2n (default is to assume sorted and check for unsorted positions, if unsorted positions are found, will fall back to slower version)
+.TP
+\fB\-\-bwbuffer\fR <1GB[default]>
+Size of buffer for reading BigWig files, critical to use a large value (~1GB) for remote BigWigs.
+Default setting should be fine for most uses, but raise if very slow on a remote BigWig.
+.PP
+BAM Input:
+Extract basic junction information from the BAM, including co\-occurrence
+If only the name of the BAM file is passed in with no other args, it will *only* report total AUC to STDOUT.
+.TP
+\fB\-\-fasta\fR
+Path to the reference FASTA file if a CRAM file is passed as the input file (ignored otherwise)
+If not passed, references will be downloaded using the CRAM header.
+.TP
+\fB\-\-junctions\fR
+Extract co\-occurring jx coordinates, strand, and anchor length, per read
+writes to a TSV file <prefix>.jxs.tsv
+.TP
+\fB\-\-all\-junctions\fR
+Extract all jx coordinates, strand, and anchor length, per read for any jx
+writes to a TSV file <prefix>.all_jxs.tsv
+.TP
+\fB\-\-longreads\fR
+Modifies certain buffer sizes to accommodate longer reads such as PB/Oxford.
+.TP
+\fB\-\-filter\-in\fR
+Integer bitmask, any bits of which alignments need to have to be kept (similar to samtools view \fB\-f\fR).
+.TP
+\fB\-\-filter\-out\fR
+Integer bitmask, any bits of which alignments need to have to be skipped (similar to samtools view \fB\-F\fR).
+.TP
+\fB\-\-add\-chr\-prefix\fR
+Adds "chr" prefix to relevant chromosomes for BAMs w/o it, pass "human" or "mouse".
+Only works for human/mouse references (default: off).
+.SS "Non-reference summaries:"
+.TP
+\fB\-\-alts\fR
+Print differing from ref per\-base coverages
+Writes to a CSV file <prefix>.alts.tsv
+.TP
+\fB\-\-include\-softclip\fR
+Print a record to the alts CSV for soft\-clipped bases
+Writes total counts to a separate TSV file <prefix>.softclip.tsv
+.TP
+\fB\-\-only\-polya\fR
+If \fB\-\-include\-softclip\fR, only print softclips which are mostly A's or T's
+.TP
+\fB\-\-include\-n\fR
+Print mismatch records when mismatched read base is N
+.TP
+\fB\-\-print\-qual\fR
+Print quality values for mismatched bases
+.TP
+\fB\-\-delta\fR
+Print POS field as +/\- delta from previous
+.TP
+\fB\-\-require\-mdz\fR
+Quit with error unless MD:Z field exists everywhere it's
+expected
+.TP
+\fB\-\-head\fR
+Print sequence names and lengths in SAM/BAM header
+.SS "Coverage and quantification:"
+.TP
+\fB\-\-coverage\fR
+Print per\-base coverage (slow but totally worth it)
+.TP
+\fB\-\-auc\fR
+Print per\-base area\-under\-coverage, will generate it for the genome
+and for the annotation if \fB\-\-annotation\fR is also passed in
+Defaults to STDOUT, unless other params are passed in as well, then
+if writes to a TSV file <prefix>.auc.tsv
+.TP
+\fB\-\-bigwig\fR
+Output coverage as BigWig file(s). Writes to <prefix>.bw
+(also <prefix>.unique.bw when \fB\-\-min\-unique\-qual\fR is specified).
+Requires libBigWig.
+.TP
+\fB\-\-annotation\fR <BED|window_size>
+Path to BED file containing list of regions to sum coverage over
+(tab\-delimited: chrm,start,end). Or this can specify a contiguous region size in bp.
+.TP
+\fB\-\-op\fR <sum[default], mean>
+Statistic to run on the intervals provided by \fB\-\-annotation\fR
+.TP
+\fB\-\-no\-index\fR
+If using \fB\-\-annotation\fR, skip the use of the BAM index (BAI) for pulling out regions.
+Setting this can be faster if doing windows across the whole genome.
+This will be turned on automatically if a window size is passed to \fB\-\-annotation\fR.
+.TP
+\fB\-\-min\-unique\-qual\fR <int>
+Output second bigWig consisting built only from alignments
+with at least this mapping quality. \fB\-\-bigwig\fR must be specified.
+Also produces second set of annotation sums based on this coverage
+if \fB\-\-annotation\fR is enabled
+.TP
+\fB\-\-double\-count\fR
+Allow overlapping ends of PE read to count twice toward
+coverage
+.TP
+\fB\-\-num\-bases\fR
+Report total sum of bases in alignments processed (that pass filters)
+.TP
+\fB\-\-gzip\fR
+Turns on gzipping of coverage output (no effect if \fB\-\-bigwig\fR is passsed),
+this will also enable \fB\-\-no\-coverage\-stdout\fR.
+.SS "Other outputs:"
+.TP
+\fB\-\-read\-ends\fR
+Print counts of read starts/ends, if \fB\-\-min\-unique\-qual\fR is set
+then only the alignments that pass that filter will be counted here
+Writes to 2 TSV files: <prefix>.starts.tsv, <prefix>.ends.tsv
+.TP
+\fB\-\-frag\-dist\fR
+Print fragment length distribution across the genome
+Writes to a TSV file <prefix>.frags.tsv
+.TP
+\fB\-\-echo\-sam\fR
+Print a SAM record for each aligned read
+.TP
+\fB\-\-ends\fR
+Report end coordinate for each read (useful for debugging)
+.TP
+\fB\-\-test\-polya\fR
+Lower Poly\-A filter minimums for testing (only useful for debugging/testing)
=====================================
debian/rules
=====================================
@@ -28,10 +28,7 @@ override_dh_auto_install:
mkdir -p debian/megadepth/usr/bin
cp obj-*/megadepth_dynamic debian/megadepth/usr/bin/megadepth
-debian/megadepth.1:
- help2man -n "Quantification of genome coverage by DNA/RNA seqencing" obj-*/megadepth_dynamic > debian/megadepth.1
-
-override_dh_installman: debian/megadepth.1
+override_dh_installman:
dh_installman
override_dh_auto_clean:
@@ -42,4 +39,3 @@ override_dh_auto_clean:
if [ -d htslib_ci ]; then rmdir htslib_ci; fi
rm -rf htslib libbigwig libBigWig libdeflate libz zlib
rm CMakeLists.txt
- rm -f debian/megadepth.1
View it on GitLab: https://salsa.debian.org/med-team/megadepth/-/compare/2b1ab945ea8c378cadf7c9d34bf350fef1ebaa20...ec58125a6b5ef84a7fda3261843397eb18c9a1f8
--
View it on GitLab: https://salsa.debian.org/med-team/megadepth/-/compare/2b1ab945ea8c378cadf7c9d34bf350fef1ebaa20...ec58125a6b5ef84a7fda3261843397eb18c9a1f8
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/debian-med-commit/attachments/20220711/3d77773b/attachment-0001.htm>
More information about the debian-med-commit
mailing list