Package picard.fastq
Class Casava18ReadNameEncoder
java.lang.Object
picard.fastq.Casava18ReadNameEncoder
- All Implemented Interfaces:
ReadNameEncoder
A read name encoder conforming to the standard described by Illumina Casava 1.8.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCasava18ReadNameEncoder
(String instrumentName, String runId, String flowcellId) -
Method Summary
Modifier and TypeMethodDescriptiongenerateReadName
(ClusterData cluster, Integer pairNumber) Generates a read name string for the provided cluster.generateShortName
(ClusterData cluster) Generates a short read name that includes a minimal amount of information, this is used primarily for read sorting.
-
Constructor Details
-
Casava18ReadNameEncoder
-
-
Method Details
-
generateReadName
Description copied from interface:ReadNameEncoder
Generates a read name string for the provided cluster.- Specified by:
generateReadName
in interfaceReadNameEncoder
- Parameters:
cluster
- The cluster whose reads are having its name generatedpairNumber
- 1 if this is the first of the pair, 2 if it is the second, or null if this not a paired read.- Returns:
- The read name
-
generateShortName
Description copied from interface:ReadNameEncoder
Generates a short read name that includes a minimal amount of information, this is used primarily for read sorting.- Specified by:
generateShortName
in interfaceReadNameEncoder
- Parameters:
cluster
- The cluster to generate the short read name from- Returns:
- The short read name
-