SequenceRangeGroupingSubtract Method |
Subtracts the query SequenceRangeGrouping from this SequenceRangeGrouping.
For example,
Ranges in this instance Ranges in the query
1 to 4 2 to 6
4 to 8 3 to 6
8 to 12 9 to 14
25 to 35
Result for minOverlap set to 1
1. If outputType is IntervalsWithNoOverlap
25 to 35
2. If outputType is NonOverlappingPiecesOfIntervals
1 to 2
6 to 8
8 to 9
25 to 35
Running this method creates all new ISequenceRange objects and adds them
to the newly created SequenceRangeGrouping returned here.
Namespace: BioAssembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)
Syntax public SequenceRangeGrouping Subtract(
SequenceRangeGrouping query,
long minOverlap = 1,
SubtractOutputType outputType = SubtractOutputType.NonOverlappingPiecesOfIntervals,
bool isParentSeqRangesRequired = false
)
Public Function Subtract (
query As SequenceRangeGrouping,
Optional minOverlap As Long = 1,
Optional outputType As SubtractOutputType = SubtractOutputType.NonOverlappingPiecesOfIntervals,
Optional isParentSeqRangesRequired As Boolean = false
) As SequenceRangeGrouping
public:
SequenceRangeGrouping^ Subtract(
SequenceRangeGrouping^ query,
long long minOverlap = 1,
SubtractOutputType outputType = SubtractOutputType::NonOverlappingPiecesOfIntervals,
bool isParentSeqRangesRequired = false
)
member Subtract :
query : SequenceRangeGrouping *
?minOverlap : int64 *
?outputType : SubtractOutputType *
?isParentSeqRangesRequired : bool
(* Defaults:
let _minOverlap = defaultArg minOverlap 1
let _outputType = defaultArg outputType SubtractOutputType.NonOverlappingPiecesOfIntervals
let _isParentSeqRangesRequired = defaultArg isParentSeqRangesRequired false
*)
-> SequenceRangeGrouping
Parameters
- query
- Type: BioSequenceRangeGrouping
Query grouping. - minOverlap (Optional)
- Type: SystemInt64
Minmum length of overlap. By default this will be set to 1 - outputType (Optional)
- Type: BioSubtractOutputType
Type of output required, IntervalsWithNoOverlap or NonOverlappingPiecesOfIntervals.
By default this will be set to NonOverlappingPiecesOfIntervals that is non overlapping
pieces of intervels along with non overlapping ranges from this instance
will be returned.
- isParentSeqRangesRequired (Optional)
- Type: SystemBoolean
If this flag is set to true then the sequence ranges from
which the new sequence range is created are added to the ParentSeqRanges property of the
new sequence range.
Return Value
Type:
SequenceRangeGroupingThe resultant Sequence range grouping.
See Also