Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved samplesheet generation for NovaSeqX. #794

Merged
merged 2 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 31 additions & 35 deletions bin/npg_samplesheet_generator_NovaSeqXSeries
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,46 @@ 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think file_name may be missing from the documentation?


C<dragen_software_version> -
DRAGEN software version to use, optional

C<file_name> -
name of the samplesheet CSV file, optional

=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 +76,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