diff --git a/R/data.R b/R/data.R index fbdca1f..5a3325e 100644 --- a/R/data.R +++ b/R/data.R @@ -13,3 +13,17 @@ #' #' @source "gsea_example" + +#' An example of KEGG results +#' +#' A wide data frame with enrichment scores (log10 FDR) from +#' MetaboAnalyst of one comparison. +#' +#' @format A data frame with 183 rows and 2 columns: +#' \describe{ +#' \item{MAP}{KEGG Pathway IDS} +#' \item{MA}{Enrichment Scores of KEGG pathways} +#' } +#' +#' @source +"kegg_example" diff --git a/README.Rmd b/README.Rmd index 2528376..4d18a37 100644 --- a/README.Rmd +++ b/README.Rmd @@ -32,7 +32,7 @@ remotes::install_github("willgryan/PAVER") ## Usage -PAVER is designed to work with the output of pathway analysis tools. The package includes a vignette with an example dataset that explains it's functionality. +PAVER is designed to work with the output of pathway analysis tools. The package includes a vignette with an example dataset that explains it's functionality. The R Shiny application for the PAVER R package is hosted at [https://cdrl.shinyapps.io/PAVER/](https://cdrl.shinyapps.io/PAVER/). For more detailed information on PAVER and its functionalities, please refer to the article on the Cognitive Disorders Research Laboratory (CDRL) website [here](https://cdrl-ut.org/project/projects_and_posters/paver/). ## Contributing diff --git a/data/kegg_example.rda b/data/kegg_example.rda new file mode 100644 index 0000000..0863f13 Binary files /dev/null and b/data/kegg_example.rda differ diff --git a/man/kegg_example.Rd b/man/kegg_example.Rd new file mode 100644 index 0000000..e6a3f2e --- /dev/null +++ b/man/kegg_example.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{kegg_example} +\alias{kegg_example} +\title{An example of KEGG results} +\format{ +A data frame with 183 rows and 2 columns: +\describe{ +\item{MAP}{KEGG Pathway IDS} +\item{MA}{Enrichment Scores of KEGG pathways} +} +} +\source{ +\url{https://doi.org/10.1101/2023.10.13.562226} +} +\usage{ +kegg_example +} +\description{ +A wide data frame with enrichment scores (log10 FDR) from +MetaboAnalyst of one comparison. +} +\keyword{datasets}