.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Bio::Tradis::Map 3pm"
.TH Bio::Tradis::Map 3pm 2024-01-25 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Bio::Tradis::Map \- Perform mapping
.SH VERSION
.IX Header "VERSION"
version 1.4.5
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Takes a reference genome and indexes it.
Maps given fastq files to ref.
.PP
.Vb 1
\&   use Bio::Tradis::Map;
\&   
\&   my $pipeline = Bio::Tradis::Map\->new(fastqfile => \*(Aqabc\*(Aq, reference => \*(Aqabc\*(Aq);
\&   $pipeline\->index_ref();
\&   $pipeline\->do_mapping();
.Ve
.SH PARAMETERS
.IX Header "PARAMETERS"
.SS Required
.IX Subsection "Required"
.IP \(bu 4
\&\f(CW\*(C`fastqfile\*(C'\fR \- path to/name of file containing reads to map to the reference
.IP \(bu 4
\&\f(CW\*(C`reference\*(C'\fR \- path to/name of reference genome in fasta format (.fa)
.SS Optional
.IX Subsection "Optional"
.IP \(bu 4
\&\f(CW\*(C`refname\*(C'\fR \- name to assign to the reference index files. Default = ref.index
.IP \(bu 4
\&\f(CW\*(C`outfile\*(C'\fR \-  name to assign to the mapped SAM file. Default = mapped.sam
.SH METHODS
.IX Header "METHODS"
.IP \(bu 4
\&\f(CW\*(C`index_ref\*(C'\fR \- create index files of the reference genome. These are required
			for the mapping step. Only skip this step if index files already
			exist. \-k and \-s options for referencing are calculated based
			on the length of the reads being mapped as per table:
.IP \(bu 4
\&\f(CW\*(C`do_mapping\*(C'\fR \- map \f(CW\*(C`fastqfile\*(C'\fR to \f(CW\*(C`reference\*(C'\fR. Options used for mapping are: \f(CW\*(C`\-r \-1 \-x \-y 0.96\*(C'\fR
.PP
For more information on the mapping and indexing options discussed here, see the SMALT manual <ftp://ftp.sanger.ac.uk/pub4/resources/software/smalt/smalt-manual-0.7.4.pdf>
.SH AUTHOR
.IX Header "AUTHOR"
Carla Cummins <path\-help@sanger.ac.uk>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2013 by Wellcome Trust Sanger Institute.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve