Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
stemangiola committed May 20, 2024
1 parent 6653e2f commit c0eeef3
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,19 @@ library(spatialOmicsWorkshop2024)
vignette("Introduction")
```

## Interactive execution of the vignettes

From command line, and enter the tidySpatialWorkshop2024 directory.

```
# Open the command line
git clone [email protected]:tidyomics/tidySpatialWorkshop2024.git
```

Alternatively download the [git zipped package](https://github.com/tidyomics/tidySpatialWorkshop2024/archive/refs/heads/devel.zip). Uncompress it. And enter the directory.


To run the code, you could then copy and paste the code from the workshop vignette or
[R markdown file](https://github.com/tidyomics/tidySpatialWorkshop2024/blob/devel/vignettes/Session_1_sequencing_assays.Rmd)
into a new R Markdown file on your computer.
Expand Down
23 changes: 21 additions & 2 deletions vignettes/Introduction.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,14 @@ You can view the material at the workshop webpage

[here](https://tidyomics.github.io/tidySpatialWorkshop2024/articles/main.html).

### Installation
## Workshop package installation

If you want to install the packages and material post-workshop, the
instructions are below. The workshop is designed for R `4.4` and
Bioconductor 3.19.

```{r, eval=FALSE}
# Install workshop package
#install.packages('BiocManager')
BiocManager::install("tidyomics/tidySpatialWorkshop2024", dependencies = TRUE)
Expand All @@ -61,15 +66,29 @@ BiocManager::install(c("lmweber/ggspavis",
"stemangiola/tidygate",
"stemangiola/CuratedAtlasQueryR"),
update = FALSE)
BiocManager::install("ggcorrplot")
# Then build the vignettes
BiocManager::install("tidyomics/tidySpatialWorkshop2024", build_vignettes = TRUE, force = TRUE)
BiocManager::install("tidyomics/tidySpatialWorkshop2024", build_vignettes = TRUE, force=TRUE)
# To view vignette
library(spatialOmicsWorkshop2024)
vignette("Introduction")
```

## Interactive execution of the vignettes

From command line, and enter the tidySpatialWorkshop2024 directory.

```
# Open the command line
git clone [email protected]:tidyomics/tidySpatialWorkshop2024.git
```

Alternatively download the [git zipped package](https://github.com/tidyomics/tidySpatialWorkshop2024/archive/refs/heads/devel.zip). Uncompress it. And enter the directory.

# Announcements


Expand Down

0 comments on commit c0eeef3

Please sign in to comment.