ContainedIn¶
-
AQPython.Query.
ContainedIn
(left, right, limit=0, negate=False)¶ Provide the ability to find annotations that are contained by another annotation.
The input is 2 Dataframes of AQAnnotations. We will call them A and B. The purpose is to find those annotations in A that are contained in B. What that means is the start/end offset for an annotation from A must be contained by the start/end offset from an annotation in B. The start/end offsets are inclusive. We ultimately return the contained annotations (A) that meet this criteria. There is also the option of negating the query (think Not Contains) so that we return only A where it is not contained in B.
- Parameters
left – Dataframe of AQAnnotations, the ones we will return if they are contained in AQAnnotations from ‘right’.
right – Dataframe of AQAnnotations, the ones we are looking to see if they contain AQAnnotations from ‘left’.
limit – Number of AQAnnotations to return.
negate – Whether to negate the entire query (think NOT contained in). Default is false.
- Returns
Dataframe of AQAnnotations