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 14, 2025
1 parent cf49f70 commit 3bfe6ed
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,30 @@ The msigdbr R package provides Molecular Signatures Database (MSigDB) gene sets
* in an R-friendly "[tidy](https://r4ds.had.co.nz/tidy-data.html)" format with one gene pair per row
* for multiple frequently studied model organisms, such as mouse, rat, pig, zebrafish, fly, and yeast, in addition to the original human genes
* as gene symbols as well as NCBI Entrez and Ensembl IDs
* without accessing external resources and requiring an active internet connection
* without accessing external resources requiring an active internet connection

## Installation

The package can be installed from [CRAN](https://cran.r-project.org/package=msigdbr).

```{r}
```r
install.packages("msigdbr")
```

Recent [releases](https://github.com/igordot/msigdbr/releases) are not available on CRAN and can be installed from GitHub (specific version can be specified):

```{r}
```r
remotes::install_github("igordot/msigdbr", ref = "v2022.1.1")
```

## Usage

The package data can be accessed using the `msigdbr()` function, which returns a data frame of gene sets and their member genes. For example, you can retrieve mouse genes from the C2 (curated) CGP (chemical and genetic perturbations) gene sets.
The package data can be accessed using the `msigdbr()` function, which returns a data frame of gene sets and their member genes.
For example, you can retrieve mouse genes from the C2 (curated) CGP (chemical and genetic perturbations) gene sets.

```{r}
```r
library(msigdbr)
genesets = msigdbr(species = "mouse", category = "C2", subcategory = "CGP")
genesets <- msigdbr(species = "mouse", category = "C2", subcategory = "CGP")
```

Check the [documentation website](https://igordot.github.io/msigdbr/articles/msigdbr-intro.html) for more information.

0 comments on commit 3bfe6ed

Please sign in to comment.