Skip to content

Commit

Permalink
update README with homepage, docker, and installation
Browse files Browse the repository at this point in the history
  • Loading branch information
lgeistlinger committed Jul 12, 2023
1 parent 518eccc commit 124cbc0
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 2 deletions.
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ Suggests:
Remotes:
lgeistlinger/SeuratData,
stemangiola/CuratedAtlasQueryR
URL: https://bioconductor.github.io/ISMB.OSCA/,
ghcr.io/bioconductor/ismb.osca
URL:
https://bioconductor.github.io/ISMB.OSCA/,
ghcr.io/bioconductor/ismb.osca
BugReports: https://github.com/Bioconductor/ISMB.OSCA/issues/new/choose
VignetteBuilder: knitr
DockerImage: ghcr.io/bioconductor/ismb.osca:latest
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ISMB 2023: Orchestrating Large-Scale Single-Cell Analysis with Bioconductor

[Tutorial homepage](https://bioconductor.github.io/ISMB.OSCA/)

## Speakers

* Dario Righelli, University of Padova, Italy
Expand Down Expand Up @@ -60,3 +62,37 @@ In particular, participants will learn:
| Case study: from data import to DE and DA | 16:15-17:00 |
| Case study: discussion | 17:00-18:00 |

## Docker container

To run this tutorial in a
[Docker container](ghcr.io/bioconductor/ismb.osca:latest),
pull the Docker image via

```
docker pull ghcr.io/bioconductor/ismb.osca:latest
```

and then run the image via

```
docker run -e PASSWORD=bioc -p 8787:8787 ghcr.io/bioconductor/ismb.osca
```

Once running, navigate to http://localhost:8787/ in your browser and login with
username `rstudio` and password `bioc`.

## Local installation

This tutorial can be installed like an ordinary R package via:

```
if (!require("BiocManager", quietly = TRUE))
install.packages("BiocManager")
if (!require("remotes", quietly = TRUE))
install.packages("remotes")
BiocManager::install("Bioconductor/ISMB.OSCA",
dependencies = TRUE,
build_vignettes = TRUE)
```

0 comments on commit 124cbc0

Please sign in to comment.