R/access.R

In jasenfinch/binneR: Spectral Processing for High Resolution Flow Infusion Mass Spectrometry

#' Binalysis class get methods
#' @rdname results
#' @description Methods for accessing spectral binning results from the  Binalysis S4 class.
#' @param x S4 object of class Binalysis
#' @details 
#' \itemize{
#'  \item{version}{ - Extract package version used to create the object.}
#'  \item{creationDate}{ - Extract the creation date of the object.}
#'  \item{filePaths}{ - Extract the sample file paths.}
#'  \item{sampleInfo}{ - Extract sample meta information.}
#'  \item{binnedData}{ - Extract a binned data intensity matrix.}
#'  \item{accurateData}{ - Extract sample-wise accurate mass data and bin measures.}
#'  \item{binningParametesr}{Extract the binning parameters.}
#' }
#' @seealso \code{\link{Binalysis-class}}, \code{\link{binneRlyse}}
#' @export

setMethod('version',signature = 'Binalysis',
					function(x){
						x@version
					})

#' @rdname results
#' @export

setMethod('creationDate',signature = 'Binalysis',
					function(x){
						x@creation_date
					})

#' @rdname results
#' @export

setMethod('filePaths',signature = 'Binalysis',
					function(x){
						x@file_paths
					})

#' @rdname results
#' @export

setMethod('sampleInfo',signature = 'Binalysis',
					function(x){
						x@sample_info
					})

#' @rdname results
#' @export

setMethod('binnedData',signature = 'Binalysis',
					function(x){
						x@binned_data
					})

setMethod('binnedData<-',signature = 'Binalysis',
					function(x,value){
						x@binned_data <- value
						return(x)
					})

#' @rdname results
#' @export

setMethod('accurateData',signature = 'Binalysis',
					function(x){
						x@accurate_mz
					})

setMethod('accurateData<-',signature = 'Binalysis',
					function(x,value){
						x@accurate_mz <- value
						return(x)
					})

#' @rdname results
#' @export

setMethod('binningParameters',signature = 'Binalysis',
					function(x){
						as(x,'BinParameters')
					})

setMethod('spectra',signature = 'Binalysis',
					function(x){
						x@spectra
					})

setMethod('spectra<-',signature = 'Binalysis',
					function(x,value){
						x@spectra <- value
						return(x)
					})