The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

=head1 NAME
CLIPSeqTools::App::size_distribution - Measure size distribution for reads.
=head1 SYNOPSIS
clipseqtools size_distribution [options/parameters]
=head1 DESCRIPTION
Measure size distribution of aligned reads.
=head1 OPTIONS
Input options for library.
--driver <Str> driver for database connection (eg. mysql,
SQLite).
--database <Str> database name or path to database file for file
based databases (eg. SQLite).
--table <Str> database table.
--host <Str> hostname for database connection.
--user <Str> username for database connection.
--password <Str> password for database connection.
--records_class <Str> type of records stored in database.
--filter <Filter> filter library. May be used multiple times.
Syntax: column_name="pattern"
e.g. keep reads with deletions AND not repeat
masked AND longer than 31
--filter deletion="def"
--filter rmsk="undef" .
--filter query_length=">31".
Operators: >, >=, <, <=, =, !=, def, undef
Output
--o_prefix <Str> output path prefix. Script will create and add
extension to path. [Default: ./]
Other options.
--plot call plotting script to create plots.
-v --verbose print progress lines and extra information.
-h -? --usage --help print help message
=cut
$CLIPSeqTools::App::size_distribution::VERSION = '0.1.0'; # TRIAL
# Make it an app command
#######################################################################
####################### Load External modules #####################
#######################################################################
use autodie;
use List::Util qw(min max);
#######################################################################
########################## Consume Roles ##########################
#######################################################################
with
"CLIPSeqTools::Role::Option::Library" => {
-alias => { validate_args => '_validate_args_for_library' },
-excludes => 'validate_args',
},
"CLIPSeqTools::Role::Option::Plot" => {
-alias => { validate_args => '_validate_args_for_plot' },
-excludes => 'validate_args',
},
"CLIPSeqTools::Role::Option::OutputPrefix" => {
-alias => { validate_args => '_validate_args_for_output_prefix' },
-excludes => 'validate_args',
};
#######################################################################
######################## Interface Methods ########################
#######################################################################
sub validate_args {
my ($self) = @_;
$self->_validate_args_for_library;
$self->_validate_args_for_plot;
$self->_validate_args_for_output_prefix;
}
sub run {
my ($self) = @_;
warn "Starting analysis: size_distribution\n";
warn "Validating arguments\n" if $self->verbose;
$self->validate_args();
warn "Creating reads collection\n" if $self->verbose;
my $reads_collection = $self->reads_collection;
$reads_collection->schema->storage->debug(1) if $self->verbose > 1;
warn "Measuring aligned read sizes\n" if $self->verbose;
my %size_count;
$reads_collection->foreach_record_do( sub {
my ($rec) = @_;
return 0 if $rec->cigar =~ /N/; # throw away reads with huge gaps (introns)
$size_count{$rec->length} += $rec->copy_number;
return 0;
});
my $min_length = min(keys %size_count);
my $max_length = max(keys %size_count);
warn "Creating output path\n" if $self->verbose;
$self->make_path_for_output_prefix();
warn "Printing results\n" if $self->verbose;
open (my $OUT1, '>', $self->o_prefix.'size_distribution.tab');
say $OUT1 join("\t", 'size', 'count');
say $OUT1 join("\t", $_, $size_count{$_} || 0) for ($min_length..$max_length);
close $OUT1;
if ($self->plot) {
warn "Creating plot\n" if $self->verbose;
CLIPSeqTools::PlotApp->initialize_command_class('CLIPSeqTools::PlotApp::size_distribution',
file => $self->o_prefix.'size_distribution.tab',
o_prefix => $self->o_prefix
)->run();
}
}
1;