docs / data_structures / read_group / ReadGroup to String
Workflow

ReadGroup to String

Validates a ReadGroup struct is well-formed and then converts it to a String
WDL Version
1.1
Category
Utility
Nested Inputs Not Allowed
RUN WITH

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

Inputs

Required Inputs

Name
Type
Description
read_group
ReadGroup
Input ReadGroup struct
Input ReadGroup struct

Other Inputs

Name
Type
Default
Description
required_fields
Array[String]
[]
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.
[]
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.
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
The validated input ReadGroup as a String
inner_read_group_to_string.stringified_read_group