annotate Roary/lib/Bio/Roary/PrepareInputFiles.pm @ 0:c47a5f61bc9f draft

Uploaded
author dereeper
date Fri, 14 May 2021 20:27:06 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
1 package Bio::Roary::PrepareInputFiles;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
2
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
3 # ABSTRACT: Take in a mixture of FASTA and GFF input files and output FASTA proteomes only
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
4
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
5 =head1 SYNOPSIS
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
6
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
7 Take in a mixture of FASTA and GFF input files and output FASTA proteomes only
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
8 use Bio::Roary::PrepareInputFiles;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
9
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
10 my $obj = Bio::Roary::PrepareInputFiles->new(
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
11 input_files => ['abc.gff','ddd.faa'],
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
12 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
13 $obj->fasta_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
14
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
15 =cut
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
16
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
17 use Moose;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
18 use Bio::Roary::Exceptions;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
19 use Bio::Roary::ExtractProteomeFromGFFs;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
20 use Bio::Roary::FilterUnknownsFromFasta;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
21 use Cwd qw(getcwd);
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
22 use File::Temp;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
23 use Log::Log4perl qw(:easy);
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
24
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
25 has 'input_files' => ( is => 'ro', isa => 'ArrayRef', required => 1 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
26 has 'job_runner' => ( is => 'ro', isa => 'Str', default => 'Local' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
27 has 'cpus' => ( is => 'ro', isa => 'Int', default => 1 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
28 has '_input_gff_files' => ( is => 'ro', isa => 'Maybe[ArrayRef]', lazy => 1, builder => '_build__input_gff_files' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
29 has '_input_fasta_files' => ( is => 'ro', isa => 'Maybe[ArrayRef]', lazy => 1, builder => '_build__input_fasta_files' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
30 has '_input_fasta_files_filtered' => ( is => 'ro', isa => 'Maybe[ArrayRef]', lazy => 1, builder => '_build__input_fasta_files_filtered' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
31 has '_input_fasta_files_filtered_obj' =>
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
32 ( is => 'ro', isa => 'Bio::Roary::FilterUnknownsFromFasta', lazy => 1, builder => '_build__input_fasta_files_filtered_obj' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
33
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
34 has '_derived_fasta_files' => ( is => 'ro', isa => 'Maybe[ArrayRef]', lazy => 1, builder => '_build__derived_fasta_files' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
35 has '_extract_proteome_obj' => (
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
36 is => 'ro',
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
37 isa => 'Bio::Roary::ExtractProteomeFromGFFs',
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
38 lazy => 1,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
39 builder => '_build__extract_proteome_obj'
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
40 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
41 has 'apply_unknowns_filter' => ( is => 'rw', isa => 'Bool', default => 1 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
42 has 'translation_table' => ( is => 'rw', isa => 'Int', default => 11 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
43 has 'verbose' => ( is => 'rw', isa => 'Bool', default => 0 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
44 has '_fasta_filter_obj' => ( is => 'ro', isa => 'Bio::Roary::FilterUnknowsFromFasta', lazy => 1, builder => '_fasta_filter_obj' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
45 has 'working_directory' => ( is => 'ro', isa => 'File::Temp::Dir', default => sub { File::Temp->newdir( DIR => getcwd, CLEANUP => 1 ); } );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
46 has 'logger' => ( is => 'ro', lazy => 1, builder => '_build_logger' );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
47
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
48 sub _build_logger {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
49 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
50 Log::Log4perl->easy_init($ERROR);
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
51 my $logger = get_logger();
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
52 return $logger;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
53 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
54
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
55 sub _build__input_gff_files {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
56 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
57 my @gff_files = grep( /\.gff$/, @{ $self->input_files } );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
58 return \@gff_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
59 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
60
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
61 sub _build__input_fasta_files {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
62 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
63 my @fasta_files = grep( !/\.gff$/, @{ $self->input_files } );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
64
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
65 my @validated_fasta_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
66
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
67 for my $fasta_file (@fasta_files) {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
68 eval {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
69 my $inseq = Bio::SeqIO->new(
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
70 -file => $fasta_file,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
71 -format => 'fasta',
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
72 -alphabet => 'protein'
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
73 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
74 while ( my $seq = $inseq->next_seq ) {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
75
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
76 # do something to force the reading.
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
77 $seq->seq;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
78 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
79 };
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
80 if ($@) {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
81 $self->logger->warn(
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
82 "Input file doesnt have a .gff extension and isnt a protein FASTA file so excluding it from further analysis: $fasta_file"
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
83 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
84 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
85 else {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
86 push( @validated_fasta_files, $fasta_file );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
87 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
88
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
89 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
90
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
91 return \@fasta_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
92 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
93
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
94 sub _build__input_fasta_files_filtered_obj {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
95 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
96 return Bio::Roary::FilterUnknownsFromFasta->new( fasta_files => $self->_input_fasta_files );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
97 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
98
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
99 sub _build__input_fasta_files_filtered {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
100 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
101 return undef if ( !defined( $self->_input_fasta_files ) );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
102 return $self->_input_fasta_files_filtered_obj->filtered_fasta_files();
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
103 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
104
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
105 sub _build__extract_proteome_obj {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
106 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
107 return Bio::Roary::ExtractProteomeFromGFFs->new(
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
108 gff_files => $self->_input_gff_files,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
109 job_runner => $self->job_runner,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
110 apply_unknowns_filter => $self->apply_unknowns_filter,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
111 translation_table => $self->translation_table,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
112 cpus => $self->cpus,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
113 verbose => $self->verbose,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
114 working_directory => $self->working_directory,
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
115 );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
116 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
117
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
118 sub _build__derived_fasta_files {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
119 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
120 return undef if ( !defined( $self->_input_gff_files ) );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
121 return $self->_extract_proteome_obj->fasta_files();
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
122 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
123
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
124 sub fasta_files {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
125 my ($self) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
126 my @output_fasta_files = ( @{ $self->_input_fasta_files_filtered }, @{ $self->_derived_fasta_files } );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
127 return \@output_fasta_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
128 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
129
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
130 sub lookup_fasta_files_from_unknown_input_files {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
131 my ( $self, $input_files ) = @_;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
132 $self->fasta_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
133
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
134 my @output_fasta_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
135 for my $input_file ( @{$input_files} ) {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
136 if ( defined( $self->_extract_proteome_obj->fasta_files_to_gff_files->{$input_file} ) ) {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
137 push( @output_fasta_files, $self->_extract_proteome_obj->fasta_files_to_gff_files->{$input_file} );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
138 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
139 else {
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
140 push( @output_fasta_files, $self->_input_fasta_files_filtered_obj->input_fasta_to_output_fasta->{$input_file} );
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
141 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
142 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
143 return \@output_fasta_files;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
144 }
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
145
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
146 no Moose;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
147 __PACKAGE__->meta->make_immutable;
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
148
c47a5f61bc9f Uploaded
dereeper
parents:
diff changeset
149 1;