Skip to content

Commit 9fcef56

Browse files
update data
1 parent fa9375f commit 9fcef56

File tree

5 files changed

+38
-57
lines changed

5 files changed

+38
-57
lines changed

R/data.R

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -261,57 +261,42 @@
261261
#'
262262
"reactome"
263263

264-
#' hypeR-GEM object of age-associated metabolites obtained from New England Centenarian Study (NECS)
264+
#' Example hypeR-GEM object (NECS)
265265
#'
266-
#' A a list object
266+
#' A small precomputed hypeR-GEM result derived from age-associated metabolites
267+
#' in the New England Centenarian Study (NECS), used for examples and tests.
267268
#'
268269
#' @docType data
269-
#'
270270
#' @usage data(hypeR_object_NECS)
271-
#'
272-
#' @format a list object
273-
#'
274-
#' @return a list object
275-
#'
271+
#' @format A list with components required by hypeR-GEM downstream functions.
272+
#' @keywords datasets
276273
#' @references TBD
277-
#'
278-
#'
279-
#'
280274
"hypeR_object_NECS"
281275

282-
283-
#' A list of enriched Metabolon-based metabolite sets (MSets) obtained from age-associated metabolites in NECS
276+
#' Metabolon-based metabolite set list (NECS-derived)
284277
#'
285-
#' A a list object
278+
#' A curated list of enriched Metabolon metabolite sets (MSets) obtained from
279+
#' age-associated metabolites in NECS.
286280
#'
287281
#' @docType data
288-
#'
289282
#' @usage data(metabolon_msets_list)
290-
#'
291-
#' @format a list object
292-
#'
293-
#' @return a list object
294-
#'
295-
#' @references Evans, A. M., DeHaven, C. D., Barrett, T., Mitchell, M. & Milgram, E.
283+
#' @format A named list of character vectors; each vector contains RefMet (or study) IDs.
284+
#' @keywords datasets
285+
#' @references Evans AM, DeHaven CD, Barrett T, Mitchell M, Milgram E.
296286
#' Integrated, Nontargeted Ultrahigh Performance Liquid Chromatography/Electrospray Ionization
297287
#' Tandem Mass Spectrometry Platform for the Identification and Relative Quantification of
298-
#' the Small-Molecule Complement of Biological Systems. Anal. Chem. 81, 6656–6667 (2009).
288+
#' the Small-Molecule Complement of Biological Systems. \emph{Anal Chem}. 2009;81:6656–6667.
299289
"metabolon_msets_list"
300290

301-
#' A list of enriched gene-sets in HALLMARK,KEGG, and REACTOME derived from "hypeR_object_NECS"
291+
#' Enriched gene set list (Hallmark, KEGG, Reactome)
302292
#'
303-
#' A a list object
293+
#' Gene sets enriched from \code{hypeR_object_NECS}, aggregated across Hallmark, KEGG,
294+
#' and Reactome collections.
304295
#'
305296
#' @docType data
306-
#'
307297
#' @usage data(gsets_list)
308-
#'
309-
#' @format a list object
310-
#'
311-
#' @return a list object
312-
#'
313-
#' @references Federico, Anthony, and Stefano Monti.
314-
#' "hypeR: an R package for geneset enrichment workflows."
315-
#' Bioinformatics 36.4 (2020): 1307-1308.
316-
#'
298+
#' @format A named list of character vectors; each vector is a gene set (Ensembl gene IDs).
299+
#' @keywords datasets
300+
#' @references Federico A, Monti S. hypeR: an R package for geneset enrichment workflows.
301+
#' \emph{Bioinformatics}. 2020;36(4):1307–1308.
317302
"gsets_list"

_pkgdown.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ reference:
5454
- '`COVID_urine`'
5555
- '`reactome`'
5656
- '`Human_ig`'
57+
- '`hypeR_object_NECS`'
58+
- '`metabolon_msets_list`'
59+
- '`gsets_list`'
5760

5861
navbar:
5962
title: "hypeR-GEM"

man/gsets_list.Rd

Lines changed: 6 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/hypeR_object_NECS.Rd

Lines changed: 4 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/metabolon_msets_list.Rd

Lines changed: 6 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)