Skip to content

Commit

Permalink
update content for demo
Browse files Browse the repository at this point in the history
  • Loading branch information
lpantano committed Jun 18, 2024
1 parent 79e34d1 commit 682dc9b
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site/*
2 changes: 2 additions & 0 deletions docs/devops.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Build platforms

Content ![](https://img.shields.io/badge/status-WorkInProgress-yellow)


## Configure to use posit package manager

Expand Down
23 changes: 17 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,25 @@

Welcome to our Platform guidelines web-page. Here analysts and developers will find guidelines on how to work with our most common environments.

## Environments
We are developing platforms for each analysis type we have experience with at HCBC. Currently we fully support:

* O2 open OnDemand:
* For RNAseq and scRNAseq analysis use `/n/app/bcbio/R4.3.1`
* With these modules on: `gcc/9.2.0 imageMagick/7.1.0 geos/3.10.2 cmake/3.22.2 R/4.3.1 fftw/3.3.10 gdal/3.1.4 udunits/2.2.28 boost/1.75.0`
* With no `bcbio` in your `PATH`
- bulk RNAseq analysis ![](https://img.shields.io/badge/status-beta-blue)

## Supported Templates
Got to each analysis type section to learn how to use our platform.

## RNAseq

* Using O2 open OnDemand:
* Remove `bcbio` from you `PATH` by commenting the line in your `.bashrc` if you have it
* Start Rstudio With these modules on: `gcc/9.2.0 imageMagick/7.1.0 geos/3.10.2 cmake/3.22.2 R/4.3.1 fftw/3.3.10 gdal/3.1.4 udunits/2.2.28 boost/1.75.0`
* When the session is started, set you library path typing this command in your console Rstudio window: `.libPaths("/n/app/bcbio/R4.3.1")`

* load bcbioR with `library(bcbioR)`
* Make sure the version is 0.1.3 with this command `packageVersion("bcbioR")` or re-install with `devtools::install_github("bcbio/bcbioR",build_manual = TRUE, build_vignettes = TRUE)`, if you are in your own environment
* Follow this instruction https://bcbio.github.io/bcbioR/#set-base-project to start you project
* Follow this instruction https://bcbio.github.io/bcbioR/#set-rnaseq-report-folder to start your RNAseq analysis

# BCBIOR Supported Templates

We used `bcbioR` to deploy folders and code to our project directories to improve robustness in our analysis.

Expand Down
2 changes: 2 additions & 0 deletions docs/pipelines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Introduction to HCBC pipelines

Content ![](https://img.shields.io/badge/status-WorkInProgress-yellow)

## Nextflow in Seqera platform

- Create an user here: https://cloud.seqera.io/login
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ site_name: HCBC Platform
nav:
- Home: index.md
- Pipelines: pipelines.md
- Developers: devops.md
theme: mkdocs

0 comments on commit 682dc9b

Please sign in to comment.