Skip to content

Commit

Permalink
Clean up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
igordot committed Feb 21, 2025
1 parent d159c2d commit dbd5781
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
5 changes: 5 additions & 0 deletions R/msigdbr.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
#'
#' Mouse MSigDB includes gene sets curated from mouse-centric datasets and specified in native mouse gene identifiers, eliminating the need for ortholog mapping.
#'
#' To access the full dataset, please install the msigdbdf package (not available on CRAN):
#' ```
#' install.packages("msigdbdf", repos = "https://igordot.r-universe.dev")
#' ```
#'
#' @param species Species name for output genes, such as `"Homo sapiens"` or `"Mus musculus"`. Use `msigdbr_species()` for available options.
#' @param db_species Species abbreviation for the human or mouse databases (`"HS"` or `"MM"`).
#' @param collection Collection abbreviation, such as `"H"` or `"C1"`. Use `msigdbr_collections()` for the available options.
Expand Down
2 changes: 1 addition & 1 deletion R/zzz.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.onAttach <- function(libname, pkgname) {
if (!requireNamespace("msigdbdf", quietly = TRUE)) {
packageStartupMessage(
"To access all the data, please install the 'msigdbdf' package with:\n",
"For full functionality, please install the 'msigdbdf' package with:\n",
"install.packages('msigdbdf', repos = 'https://igordot.r-universe.dev')"
)
}
Expand Down
5 changes: 5 additions & 0 deletions man/msigdbr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit dbd5781

Please sign in to comment.