R/groupingInfo.R

In shambam/cellexalvrR: Provides the backend calculations for CellexalVR

#' returns the information stored for the last grouping read
#'@param cellexalObj A cellexalvr object
#'@param gname The optional group name to get info on a specific grouping (not the last)
#'@keywords groupingInfo
#'@export groupingInfo

groupingInfo <- function( cellexalObj, gname=NULL ) {
	if ( is.null(gname)){
		gname = cellexalObj@usedObj$lastGroup
	}
	ret <- list( 
			grouping = cellexalObj@userGroups[,gname] ,
			order = 1:ncol(cellexalObj@data),
			'mds' = cellexalObj@groupSelectedFrom[[gname]],
			col = cellexalObj@colors[[gname]] 
	)
	if ( ! is.na(match(paste(cellexalObj@usedObj$lastGroup, 'order'), colnames(cellexalObj@data))) ){
		ret[['order']] = cellexalObj@userGroups[,paste(gname, 'order')]
	}
	
	ret
}