Class MolecularSequence.Quality.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.MolecularSequence.Quality.Builder
-
- Enclosing class:
- MolecularSequence.Quality
public static class MolecularSequence.Quality.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MolecularSequence.Quality
build()
Build theMolecularSequence.Quality
MolecularSequence.Quality.Builder
end(java.lang.Integer end)
Convenience method for settingend
.MolecularSequence.Quality.Builder
end(Integer end)
End position of the sequence.MolecularSequence.Quality.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.MolecularSequence.Quality.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected MolecularSequence.Quality.Builder
from(MolecularSequence.Quality quality)
MolecularSequence.Quality.Builder
fScore(Decimal fScore)
Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).MolecularSequence.Quality.Builder
gtFP(Decimal gtFP)
The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e.MolecularSequence.Quality.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).MolecularSequence.Quality.Builder
method(CodeableConcept method)
Which method is used to get sequence quality.MolecularSequence.Quality.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.MolecularSequence.Quality.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.MolecularSequence.Quality.Builder
precision(Decimal precision)
QUERY.TP / (QUERY.TP + QUERY.FP).MolecularSequence.Quality.Builder
queryFP(Decimal queryFP)
False positives, i.e.MolecularSequence.Quality.Builder
queryTP(Decimal queryTP)
True positives, from the perspective of the query data, i.e.MolecularSequence.Quality.Builder
recall(Decimal recall)
TRUTH.TP / (TRUTH.TP + TRUTH.FN).MolecularSequence.Quality.Builder
roc(MolecularSequence.Quality.Roc roc)
Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.MolecularSequence.Quality.Builder
score(Quantity score)
The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.MolecularSequence.Quality.Builder
standardSequence(CodeableConcept standardSequence)
Gold standard sequence used for comparing against.MolecularSequence.Quality.Builder
start(java.lang.Integer start)
Convenience method for settingstart
.MolecularSequence.Quality.Builder
start(Integer start)
Start position of the sequence.MolecularSequence.Quality.Builder
truthFN(Decimal truthFN)
False negatives, i.e.MolecularSequence.Quality.Builder
truthTP(Decimal truthTP)
True positives, from the perspective of the truth data, i.e.MolecularSequence.Quality.Builder
type(QualityType type)
INDEL / SNP / Undefined variant.protected void
validate(MolecularSequence.Quality quality)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public MolecularSequence.Quality.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public MolecularSequence.Quality.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public MolecularSequence.Quality.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public MolecularSequence.Quality.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public MolecularSequence.Quality.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
type
public MolecularSequence.Quality.Builder type(QualityType type)
INDEL / SNP / Undefined variant.This element is required.
- Parameters:
type
- indel | snp | unknown- Returns:
- A reference to this Builder instance
-
standardSequence
public MolecularSequence.Quality.Builder standardSequence(CodeableConcept standardSequence)
Gold standard sequence used for comparing against.- Parameters:
standardSequence
- Standard sequence for comparison- Returns:
- A reference to this Builder instance
-
start
public MolecularSequence.Quality.Builder start(java.lang.Integer start)
Convenience method for settingstart
.- Parameters:
start
- Start position of the sequence- Returns:
- A reference to this Builder instance
- See Also:
start(org.linuxforhealth.fhir.model.type.Integer)
-
start
public MolecularSequence.Quality.Builder start(Integer start)
Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.- Parameters:
start
- Start position of the sequence- Returns:
- A reference to this Builder instance
-
end
public MolecularSequence.Quality.Builder end(java.lang.Integer end)
Convenience method for settingend
.- Parameters:
end
- End position of the sequence- Returns:
- A reference to this Builder instance
- See Also:
end(org.linuxforhealth.fhir.model.type.Integer)
-
end
public MolecularSequence.Quality.Builder end(Integer end)
End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.- Parameters:
end
- End position of the sequence- Returns:
- A reference to this Builder instance
-
score
public MolecularSequence.Quality.Builder score(Quantity score)
The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology. org/browser/current_svn/term/SO:0001685)).- Parameters:
score
- Quality score for the comparison- Returns:
- A reference to this Builder instance
-
method
public MolecularSequence.Quality.Builder method(CodeableConcept method)
Which method is used to get sequence quality.- Parameters:
method
- Method to get quality- Returns:
- A reference to this Builder instance
-
truthTP
public MolecularSequence.Quality.Builder truthTP(Decimal truthTP)
True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.- Parameters:
truthTP
- True positives from the perspective of the truth data- Returns:
- A reference to this Builder instance
-
queryTP
public MolecularSequence.Quality.Builder queryTP(Decimal queryTP)
True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.- Parameters:
queryTP
- True positives from the perspective of the query data- Returns:
- A reference to this Builder instance
-
truthFN
public MolecularSequence.Quality.Builder truthFN(Decimal truthFN)
False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.- Parameters:
truthFN
- False negatives- Returns:
- A reference to this Builder instance
-
queryFP
public MolecularSequence.Quality.Builder queryFP(Decimal queryFP)
False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.- Parameters:
queryFP
- False positives- Returns:
- A reference to this Builder instance
-
gtFP
public MolecularSequence.Quality.Builder gtFP(Decimal gtFP)
The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).- Parameters:
gtFP
- False positives where the non-REF alleles in the Truth and Query Call Sets match- Returns:
- A reference to this Builder instance
-
precision
public MolecularSequence.Quality.Builder precision(Decimal precision)
QUERY.TP / (QUERY.TP + QUERY.FP).- Parameters:
precision
- Precision of comparison- Returns:
- A reference to this Builder instance
-
recall
public MolecularSequence.Quality.Builder recall(Decimal recall)
TRUTH.TP / (TRUTH.TP + TRUTH.FN).- Parameters:
recall
- Recall of comparison- Returns:
- A reference to this Builder instance
-
fScore
public MolecularSequence.Quality.Builder fScore(Decimal fScore)
Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).- Parameters:
fScore
- F-score- Returns:
- A reference to this Builder instance
-
roc
public MolecularSequence.Quality.Builder roc(MolecularSequence.Quality.Roc roc)
Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.- Parameters:
roc
- Receiver Operator Characteristic (ROC) Curve- Returns:
- A reference to this Builder instance
-
build
public MolecularSequence.Quality build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
MolecularSequence.Quality
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Quality per the base specification
-
validate
protected void validate(MolecularSequence.Quality quality)
-
from
protected MolecularSequence.Quality.Builder from(MolecularSequence.Quality quality)
-
-