File Coverage

blib/lib/Bio/Palantir/Explorer.pm
Criterion Covered Total %
statement 9 9 100.0
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 12 12 100.0


line stmt bran cond sub pod time code
1             package Bio::Palantir::Explorer;
2             # ABSTRACT: front-end class for Bio::Palantir::Explorer module, wich handles the NRPS/PKS domain exploration without pre-existing consensus architecture
3             $Bio::Palantir::Explorer::VERSION = '0.211420';
4 1     1   8 use warnings;
  1         3  
  1         43  
5 1     1   7 use strict;
  1         2  
  1         28  
6              
7 1     1   544 use Bio::Palantir::Explorer::ClusterFasta;
  1         5  
  1         65  
8              
9              
10             1;
11              
12             __END__
13              
14             =pod
15              
16             =head1 NAME
17              
18             Bio::Palantir::Explorer - front-end class for Bio::Palantir::Explorer module, wich handles the NRPS/PKS domain exploration without pre-existing consensus architecture
19              
20             =head1 VERSION
21              
22             version 0.211420
23              
24             =head1 DESCRIPTION
25              
26             This module implements classes and their methods for B<exploring NRPS/PKS domain
27             architecture> without any previous consensus imposed. Note that this application
28             mode is only based on the expertise of the user. The input used by
29             C<Palantir::Refiner> is the B<FASTA file> of a NRPS/PKS BGC (e.g.,
30             F<nrps_bgc.fasta>), which can be extracted from B<antiSMASH HTML webpages> or
31             with the script C<bin/extract_fasta.pl> (which uses C<Palantir::Parser>).
32              
33             The exploratory B<Biosynthetic Gene Cluster (BGC) information> is hierarchically
34             organized as follows:
35              
36             C<ClusterFasta.pm>: contains attributes and methods for the BGC B<Cluster>
37             level, including an array of GeneFasta objects
38              
39             C<GeneFasta.pm>: contains attributes and methods for the BGC B<Gene> level,
40             including an array of DomainPlus objects (if NRPS/PKS BGCs)
41              
42             C<DomainPlus.pm>: contains attributes and methods for the BGC B<Domain> level
43              
44             The B<Domain> information is inherited from C<Palantir::Refiner::DomainPlus>,
45             and as no consensus architecture is defined, B<Module> information is not
46             applicable.
47              
48             =head1 AUTHOR
49              
50             Loic MEUNIER <lmeunier@uliege.be>
51              
52             =head1 COPYRIGHT AND LICENSE
53              
54             This software is copyright (c) 2019 by University of Liege / Unit of Eukaryotic Phylogenomics / Loic MEUNIER and Denis BAURAIN.
55              
56             This is free software; you can redistribute it and/or modify it under
57             the same terms as the Perl 5 programming language system itself.
58              
59             =cut