Switch theme
docs / data_structures / read_group / ReadGroup to String

  • Search icon

Workflow

ReadGroup to String

Validates a ReadGroup struct is well-formed and then converts it to a String
WDL Version
1.3
Category
Utility
Nested Inputs Not Allowed
data_structures/read_group.wdl
RUN WITH

sprocket run --target read_group_to_string data_structures/read_group.wdldata_structures\read_group.wdl [INPUTS]...

Inputs

Required Inputs

Name
Type
Description
read_group
Input ReadGroup struct
Input ReadGroup struct

Other Inputs

Name
Type
Default
Description
required_fields
Array[String]
["SM"]
Array of read group fields that must be defined. The ID field is always required and does not need to be specified.
Array of read group fields that must be defined. The ID field is always required and does not need to be specified.
["SM"]
format_as_sam_record
Boolean
false
Format the ReadGroup as a SAM record?
Format the ReadGroup as a SAM record?
false
If true, the read group string will be prefixed with @RG and tab escape sequence (\t) delimiters will be used instead of space delimiters.
split_on_field
Boolean
false
Split the ReadGroup into separate array elements, one per field, instead of a si...
Split the ReadGroup into separate array elements, one per field, instead of a single String. Behavior is undefined if format_as_sam_record == true.
false
restrictive
Boolean
true
If true, run a stricter validation of field values. Otherwise, check against SAM spec-defined values.
If true, run a stricter validation of field values. Otherwise, check against SAM spec-defined values.
true

Outputs

Name
Type
Expression
Description
validated_read_group
String?
inner_read_group_to_string.stringified_read_group
The validated input ReadGroup as a String. Undefined if split_on_field == true.
The validated input ReadGroup as a String. Undefined if split_on_field == true.
inner_read_group_to_string.stringified_read_group
validated_read_group_array
Array[String]?
inner_read_group_to_string.read_group_array
The validated input ReadGroup as an Array[String], one entry per field. Undefined if split_on_field == false.
The validated input ReadGroup as an Array[String], one entry per field. Undefined if split_on_field == false.
inner_read_group_to_string.read_group_array