R/5-data_in_package.R

#' @title Sample information note
#' 
#' @description sample_info_note
#' A data frame contains description for each sample information column.
#' @name sample_info_note
#' @aliases sample_info_note
#' @format A data frame with 4 rows (4 columns in sample_info) and 2 columns.
#' @docType data
#' @keywords data
#' @examples
#' data(sample_info_note)
NA


#' @title Sample information
#' 
#' @description sample_info
#' A data frame contains the sample information.
#' @name sample_info
#' @aliases sample_info
#' @format A data frame with 8 rows (8 samples) and 4 columns.
#' @docType data
#' @keywords data
#' @examples
#' data(sample_info)
NA

#' @title Expression data
#' 
#' @description expression_data
#' A data frame contains the expression values for each variable in each sample.
#' @name expression_data
#' @aliases expression_data
#' @format A data frame with 1000 rows (1000 variables) and 8 columns (8 samples).
#' @docType data
#' @keywords data
#' @examples
#' data(expression_data)
NA


#' @title Variable information note
#' 
#' @description variable_info_note
#' A data frame contains description for each variable information column.
#' @name variable_info_note
#' @aliases variable_info_note
#' @format A data frame with 3 rows (3 columns in variable_info) and 2 columns.
#' @docType data
#' @keywords data
#' @examples
#' data(variable_info_note)
NA


#' @title Variable information
#' 
#' @description variable_info
#' A data frame contains the variable information.
#' @name variable_info
#' @aliases variable_info
#' @format A data frame with 1000 rows (1000 variables) and 3 columns.
#' @docType data
#' @keywords data
#' @examples
#' data(variable_info)
NA

#' @title zmine feature table
#' 
#' @description mzmine_table
#' An example feature table from mzMine.
#' @name mzmine_table
#' @aliases mzmine_table
#' @format A data frame.
#' @docType data
#' @keywords data
#' @examples
#' data(mzmine_table)
NA

#' @title msdial_table feature table
#' 
#' @description msdial_table
#' An example feature table from mzMine.
#' @name msdial_table
#' @aliases msdial_table
#' @format A data frame.
#' @docType data
#' @keywords data
#' @examples
#' data(msdial_table)
NA
tidymass/massdataset documentation built on Jan. 30, 2024, 2:55 p.m.