getBarcodes.Rd
Returns a character vector of barcode names. See details for more.
getBarcodes(object, across = NULL, across_subset = NULL, simplify = TRUE)
An object of class SPATA2
or, in case of S4 generics,
objects of classes for which a method has been defined.
Character value or NULL. Specifies the grouping variable of interest.
Use getGroupingOptions()
to obtain all variable names that group the
barcode spots of your object in a certain manner.
Character vector or NULL. Specifies the particular groups
of interest the grouping variable specified in argument across
contains.
If set to NULL all of them are chosen. You can prefix groups you are NOT interested in with a '-'. (Saves writing if there are more groups you are interested in than groups you are not interested in.)
Use getGroupNames()
to obtain all valid input options.
Logical. If set to TRUE the output list is simplified to a vector if possible. If set to FALSE a list is returned.
Named character vector or list.
If argument across
is specified the output is named according
to the group membership the variable specified assigns the barcode spots to.
If simplify is set to FALSE a list is returned.
Not specifying across
makes the function return an unnamed character
vector containing all barcodes.