getImgAnnBorderDf | R Documentation |
Extracts the coordinates of the vertices polygons that represent the borders of the image annotation.
getImgAnnBorderDf(...)
getImageAnnotationAreaDf(...)
getImgAnnOutlineDf(
object,
ids = NULL,
tags = NULL,
test = "any",
outer = TRUE,
inner = TRUE,
add_tags = FALSE,
sep = " & ",
last = " & "
)
... |
Used to absorb deprecated arguments or functions. |
object |
An object of class |
ids |
Character vector or |
tags |
Character vector or |
test |
Character value. One of any. all, identical, not_identical and
none. Specifies how input for |
outer |
Logical value. Only applies if an image annotation contains a secondary image annotation within its own area. If |
inner |
Logical value. Only applies if an image annotation contains a secondary image annotation within its own area. If |
The variables x and y give the position of the vertices of the polygon
that was drawn to encircle the structure createImageAnnotations()
. These vertices correspond
to the border of the annotation.
A data.frame that contains variables id, border, and the numeric variables x, y and tags.
Input for argument tags
specifies the tags of interest.
Argument test
decides about how the specified tags are used to select
the image annotations of interest. There are multiple options:
Argument test
set to 'any' or 1: To be included, an image annotation
must be tagged with at least one of the input tags.
Argument test
set to 'all' or 2: To be included, an image annotation
must be tagged with all of the input tags. Can contain tags that are not specified.
Argument test
set to 'identical' or 3: To be included, an image annotation
must be tagged with all of the input tags. Can not be tagged with anything else.
Argument test
set to not_identical or 4: To be included, an image
annotation must not be tagged with the combination of input tags.
Argument test
set to 'none' or 5: To be included, an image annotation
must not contain any of the input tags.
Note that the filtering process happens after the filtering by input for argument
ids
. You can first select a group of image annotations by naming their IDs
and then select among them via tags and test. If ids
is NULL
, you select
among all image annotations via tags and test. And if tags
is also NULL
,
the function uses all image annoations.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.