R/documented_objects.R

In daewoooo/breakpointR: Find breakpoints in Strand-seq data

#' BreakPoint object
#'
#' The \code{BreakPoint} object is output of the function \code{\link{runBreakpointr}} and is basically a list with various entries. The class() attribute of this list was set to "BreakPoint". Entries can be accessed with the list operators '[[]]' and '$'.
#'
#' @name BreakPoint
#' @return
#' \item{fragments}{A \code{\link{GRanges-class}} object with read fragments.}
#' \item{deltas}{A \code{\link{GRanges-class}} object with deltaWs.}
#' \item{breaks}{A \code{\link{GRanges-class}} object containing the breakpoint coordinates.}
#' \item{counts}{A \code{\link{GRanges-class}} object with the regions between breakpoints.}
#' \item{params}{A vector with parameters that were used to obtain the results.}
#'
#' @seealso runBreakpointr
NULL