Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
assaron committed Mar 27, 2024
1 parent 9eeb7d8 commit 1a1636f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 10 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ library(devtools)
install_github("ctlab/phantasusLite")
```

Note that the latest version depends on `rhdfclient5 >= 1.25.1` from
Bioconductor 3.19, which on older systems can be more convenient to
install from GitHub:

``` r
library(devtools)
install_github("vjcitn/rhdf5client")
```

## Dependencies

To run the code you need:
Expand Down Expand Up @@ -64,14 +73,13 @@ head(exprs(es))
## GSM1281306 GSM1281307

Function loadCountsFromHSDS returns an ExpressionSet with the expression
matrix – the second exprs(es) contains an expression matrix.

The remote repository URL is
matrix – now `exprs(es)` contains an expression matrix. The default
remote repository URL is
<https://alserglab.wustl.edu/hsds/?domain=/counts>’.

``` r
url <- 'https://alserglab.wustl.edu/hsds/?domain=/counts'
es <- loadCountsFromHSDS(es, url)
# `url` is explicitly specified for illustration purposes and can be omitted
es <- loadCountsFromHSDS(es, url = 'https://alserglab.wustl.edu/hsds/?domain=/counts')
head(exprs(es))
```

Expand Down
15 changes: 10 additions & 5 deletions README.rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ library(devtools)
install_github("ctlab/phantasusLite")
```

Note that the latest version depends on `rhdfclient5 >= 1.25.1` from Bioconductor 3.19, which on older systems can be more convenient to install from GitHub:

```{r message=FALSE, eval=FALSE}
library(devtools)
install_github("vjcitn/rhdf5client")
```

## Dependencies

To run the code you need:
Expand Down Expand Up @@ -61,13 +68,11 @@ ExpressionSet from the GEO doesn't contain the expression matrix -- `exprs(es)`
head(exprs(es))
```

Function loadCountsFromHSDS returns an ExpressionSet with the expression matrix -- the second exprs(es) contains an expression matrix.

The remote repository URL is '<https://alserglab.wustl.edu/hsds/?domain=/counts>'.
Function loadCountsFromHSDS returns an ExpressionSet with the expression matrix -- now `exprs(es)` contains an expression matrix. The default remote repository URL is '<https://alserglab.wustl.edu/hsds/?domain=/counts>'.

```{r}
url <- 'https://alserglab.wustl.edu/hsds/?domain=/counts'
es <- loadCountsFromHSDS(es, url)
# `url` is explicitly specified for illustration purposes and can be omitted
es <- loadCountsFromHSDS(es, url = 'https://alserglab.wustl.edu/hsds/?domain=/counts')
head(exprs(es))
```

Expand Down

0 comments on commit 1a1636f

Please sign in to comment.