view release on metacpan or  search on metacpan

lib/Alien/SeqAlignment/bowtie2.pm  view on Meta::CPAN

 Alien::SeqAlignment::bowtie2->bowtie2_inspect_l  (list of arguments)
 Alien::SeqAlignment::bowtie2->bowtie2_align_l    (list of arguments)

=head1 DESCRIPTION

This distribution provides bowtie2 so that it can be used by other
Perl distributions that are on CPAN.  The source code will be downloaded
from the github repository and installed in a private location if it is 
not already installed in your system. The bowtie2, bowtie2-build and 
bowtie2-inspect executables are actually wrapper scripts that call binary 
programs as appropriate. The wrappers shield users from having to distinguish 
between "small" (<4GB) and "large" (>4GB)  index formats. 
Also, the bowtie2 (Perl!) wrapper provides some key functionality, 
like the ability to handle compressed inputs, and the functionality 
for --un, --al and related options. While the creators of bowtie2 recommend 
that one always runs the bowtie2 wrappers and not the binaries, application
builders may want to call these functions directly when implementing custom
workflows. Hence, this distributions exposes all functions provided in bowtie2

=head1 METHODS

=head2 bowtie2

 Alien::SeqAlignment::bowtie2->bowtie2            (list of arguments)
 Alien::SeqAlignment::bowtie2->bowtie2_align_s    (list of arguments)
 Alien::SeqAlignment::bowtie2->bowtie2_align_l    (list of arguments)
  
Returns the command name for running the CLI version of the bowtie2 aligner.
The method effectively runs the perl script bowtie2.pl that is distributed
with bowtie2. The methods Alien::SeqAlignment::bowtie2->bowtie2_align_s and
Alien::SeqAlignment::bowtie2->bowtie2_align_l return the binary executables
that align against small and large index formats respectively.


=cut

sub bowtie2 {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2} ;
}

sub bowtie2_align_l {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_align_l} ;
};

sub bowtie2_align_s {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_align_s} ;
}


=head2 bowtie2_build

 Alien::SeqAlignment::bowtie2->bowtie2_build     (list of arguments)
 Alien::SeqAlignment::bowtie2->bowtie2_build_s   (list of arguments)
 Alien::SeqAlignment::bowtie2->bowtie2_build_l   (list of arguments)
  
Returns the command name for the python application bowtie2-build,that builds 
the database of the reference sequences. bowtie2-build can generate either 
small or large indexes. The wrapper will decide which based on the length of 
the input genome. If the reference does not exceed 4 billion characters but 
a large index is preferred, the user can specify --large-index to force 
bowtie2-build to build a large index instead.
The methods Alien::SeqAlignment::bowtie2->bowtie2_build_s and 
Alien::SeqAlignment::bowtie2->bowtie2_build_l return the names of the *binary*
executables that bowtie2-build wraps over.


=cut

sub bowtie2_build {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_build} ;
}

sub bowtie2_build_s {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_build_s} ;
}

sub bowtie2_build_l {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_build_l} ;
}


=head2 bowtie2_inspect

 Alien::SeqAlignment::bowtie2->bowtie2_inspect    (list of arguments)
 Alien::SeqAlignment::bowtie2->bowtie2_inspect_s  (list of arguments)
 Alien::SeqAlignment::bowtie2->bowtie2_inspect_l  (list of arguments)
 
bowtie2-inspect extracts information from a Bowtie index about what kind of 
index it is and what reference sequences were used to build it. This method 
provides an interface to the python wrapper function over the binary 
executables Alien::SeqAlignment::bowtie2->bowtie2_inspect_s and
Alien::SeqAlignment::bowtie2->bowtie2_inspect_l that inspect short and long
format indices. 

=cut

sub bowtie2_inspect {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_inspect} ;
}

sub bowtie2_inspect_s {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_inspect_s} ;
}

sub bowtie2_inspect_l {
    my ($class) = @_;
  $class->runtime_prop->{command}->{bowtie2_inspect_l} ;
}


=head1 SEE ALSO

=over 4