Skip to content

Commit

Permalink
Improved samplesheet generation for NovaSeqX.
Browse files Browse the repository at this point in the history
Commented out code deleted.
Attributes and methods are ordered more logically.
Some private accesors are converted to public.
Documentation improved.
Added index_read_length and read_length attributes so that
these values can be set by the caller.
  • Loading branch information
mgcam committed Dec 15, 2023
1 parent e63a39e commit 7b3e06e
Show file tree
Hide file tree
Showing 3 changed files with 271 additions and 244 deletions.
60 changes: 25 additions & 35 deletions bin/npg_samplesheet_generator_NovaSeqXSeries
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,40 @@ npg_samplesheet_generator_NovaSeqXSeries

C<help> - displays help message and exists

C<varcall> - variant calling mode, defaults to C<None>, other valid options
C<SmallVariantCaller> and C<AllVariantCallers>

C<batch_id> - LIMS batch identifier, optional

C<id_run> - NPG run ID, optional; if supplied, the record for this run
should exists in the run tracking database

C<read_length> -
an optional list of read lengths, forward first, reverse
second; currently both default to 151

C<index_read_length> -
an optional list of index read lengths for the first and,
optionally, second index read; if not given, computed from
the length of barcodes recorded in LIMS

C<align> - a boolean option, false by default; if set, the DRAGEN
germline analysis section is added to the file if suitable
samples are present
C<keep_fastq> - an option to keep FASTQ files for aligned data, false
default
C<dragen_max_number_of_configs> - DRAGEN analysis can deal with a limited
number of distinct configurations. Set this attribute if
processing not on-board.

C<varcall> - variant calling mode, defaults to C<None>, other valid options
C<SmallVariantCaller> and C<AllVariantCallers>

C<keep_fastq> -
an option to keep FASTQ files for aligned data, false by
default

C<dragen_max_number_of_configs> -
DRAGEN analysis can deal with a limited number of distinct
configurations. Set this attribute if processing off-board.

=head1 DESCRIPTION

Samplesheet generation to initiate DRAGEN analysis of data sequenced
on the NovaSeq Series X Illumina instrument.
Generates a samplesheet for the NovaSeq Series X Illumina instrument and
DRAGEN analysis.

=head1 EXIT STATUS

Expand All @@ -56,37 +70,13 @@ on the NovaSeq Series X Illumina instrument.

=head1 CONFIGURATION

Access to the ml warehouse database is required.
Access to both ml warehouse and npg tracking database is required.

=head1 DEPENDENCIES

=over

=item strict

=item warnings

=item Carp

=item Text::CSV

=item Readonly

=item List::MoreUtils

=item List::Util

=item Getopt::Long

=item Pod::Usage

=item DateTime

=item Data::UUID

=item st::api::lims

=item npg_tracking::Schema
=item npg::samplesheet::novaseq_xseries

=back

Expand Down
Loading

0 comments on commit 7b3e06e

Please sign in to comment.