Diff of /R/data.R [000000] .. [0f2269]

Switch to unified view

a b/R/data.R
1
# The annotation file for the DATA in the data directory can all be commented in this file. Although LazyData: true is marked in the DESCRIPTION,
2
# it ensures that the data is not read initially but is automatically read when it is actually used. This automatic process requires this part of the file to ensure it.
3
4
#' All DEGs Venn Diagram Data
5
#'
6
#' A dataset containing the differentially expressed genes (DEGs) from four different statistical analysis methods: DESeq2, edgeR, limma, and Wilcoxon test.
7
#' This dataset is used for generating Venn diagrams to compare the overlap of DEGs identified by different methods.
8
#'
9
#' @format A list with the following components:
10
#' \describe{
11
#'   \item{DESeq2}{A vector of gene IDs or gene symbols identified as DEGs by the DESeq2 method.}
12
#'   \item{edgeR}{A vector of gene IDs or gene symbols identified as DEGs by the edgeR method.}
13
#'   \item{limma}{A vector of gene IDs or gene symbols identified as DEGs by the limma method. }
14
#'   \item{Wilcoxon_test}{A vector of gene IDs or gene symbols identified as DEGs by the Wilcoxon test method. }
15
#' }
16
#'
17
#' @source The data was derived from differential expression analyses performed on a gene expression dataset using four commonly used statistical methods (DESeq2, edgeR, limma, and Wilcoxon test).
18
#'
19
#' @usage data(all_degs_venn)
20
#'
21
#' @examples
22
#' data(all_degs_venn)
23
#' # Example of plotting a Venn diagram using the dataset
24
#'
25
#' edge_colors <- c("#1b62bb","#13822e","#332c3a","#9e2d39")
26
#' name_color <- c("#1b64bb","#13828e","#337c3a","#9e9d39")
27
#' fill_colors <- c("#e3f2fa", "#0288d1")
28
#'
29
#' Contrast_degs_venn <- Contrast_Venn(all_degs_venn, edge_colors, name_color, fill_colors)
30
#'
31
#' @keywords datasets
32
"all_degs_venn"
33
34
35
#' Phylogenetic Tree Object
36
#'
37
#' A dataset containing a phylogenetic tree object created using the `ggtree` package.
38
#' This tree represents the evolutionary relationships among a set of species or genes.
39
#'
40
#' @format A `ggtree` object.
41
#'
42
#' @source The phylogenetic tree was constructed based on sequence alignment data obtained from [Data Source, e.g., NCBI database, specific study, etc.].
43
#'
44
#' @usage data(gtree)
45
#'
46
#' @keywords datasets phylogenetics
47
"gtree"