File: samtools-fixmate.1

package info (click to toggle)
samtools 1.21-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 21,804 kB
  • sloc: ansic: 33,931; perl: 7,702; sh: 452; makefile: 298; java: 158
file content (120 lines) | stat: -rw-r--r-- 3,551 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
'\" t
.TH samtools-fixmate 1 "12 September 2024" "samtools-1.21" "Bioinformatics tools"
.SH NAME
samtools fixmate \- fills in mate coordinates and insert size fields.
.\"
.\" Copyright (C) 2008-2011, 2013-2018 Genome Research Ltd.
.\" Portions copyright (C) 2010, 2011 Broad Institute.
.\"
.\" Author: Heng Li <lh3@sanger.ac.uk>
.\" Author: Joshua C. Randall <jcrandall@alum.mit.edu>
.\"
.\" 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.
.
.\" For code blocks and examples (cf groff's Ultrix-specific man macros)
.de EX

.  in +\\$1
.  nf
.  ft CR
..
.de EE
.  ft
.  fi
.  in

..
.
.SH SYNOPSIS
.PP
samtools fixmate
.RB [ -rpcmu ]
.RB [ -O
.IR format ]
.I in.nameSrt.bam out.bam

.SH DESCRIPTION
.PP
Fill in mate coordinates, ISIZE and mate related flags from a
name-sorted or name-collated alignment.

.SH OPTIONS
.TP 11
.B -r
Remove secondary and unmapped reads.  If one of a pair is removed, the PAIRED
flag will not be unset on the remaining read.  This is a change from the older
behaviour in samtools versions up to 1.20.
.TP
.B -p
Disable FR proper pair check.
.TP
.B -c
Add template cigar ct tag.
.TP
.B -m
Add ms (mate score) tags.  These are used by
.B markdup
to select the best reads to keep.
.TP
.B -M
Fix any base modification tags (MM, ML and MN).  If we have secondary
alignments with hard-clipping and the hard clipped reads do not have
an MN tag then we use the base modification tags in the primary
alignment to clip the secondary alignment modifications, adding MN
tags in the process.

This also does other sanity checks on the consistency of these tags.
.TP
.B -u
Output uncompressed BAM or CRAM.
.TP
.BI "-O " FORMAT
Write the final output as
.BR sam ", " bam ", or " cram .

By default, samtools tries to select a format based on the output
filename extension; if output is to standard output or no format can be
deduced,
.B bam
is selected.
.TP
.BI --no-PG
Do not add a @PG line to the header of the output file.
.TP
.BI "-@, --threads " INT
Number of input/output compression threads to use in addition to main thread [0].
.TP
.BI "-z " FLAGs ", --sanitize " FLAGs
Perform basic sanitizing of records.  \fIFLAGs\fR is a comma-separated
list of keywords, defined in the
.IR samtools-view (1)
man page.  By default all FLAGs are enabled.  Use \fB-z off\fR to
disable this.

.SH AUTHOR
.PP
Written by Heng Li from the Sanger Institute.

.SH SEE ALSO
.IR samtools (1),
.IR samtools-markdup (1),
.IR samtools-sort (1),
.IR samtools-collate (1)
.PP
Samtools website: <http://www.htslib.org/>