Skip to content

Commit 7607b32

Browse files
committed
Re-organize a bit: add PARTs, add a new chapter, start some of the data chapter
1 parent 95c90c0 commit 7607b32

17 files changed

+102
-34
lines changed

01_data.Rmd

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# (PART) Get RNA-seq data! {-}
2+
3+
# Data
4+
5+
`recount3` provides processed RNA-seq data for human and mouse in file formats similar to `recount2` (Figure \@ref(fig:recountWorkflowFig1)), which at its core is based on coverage bigWig files and exon-exon junction counts (see [Raw file](#raw-files) for more details). These two raw files power the whole `recount3` ecosystem. In `recount3`, we have provided coverage count files for several human and mouse annotations with samples grouped by study. Some large studies, like [GTEx](TODO) and [TCGA](TODO) have been fragmented at the tissue level to make the data more accessible.
6+
7+
```{r "recountWorkflowFig1", out.width="100%", fig.align="center", fig.cap = "Overview of the data available in recount2 and recount3. Reads (pink boxes) aligned to the reference genome can be used to compute a base-pair coverage curve and identify exon-exon junctions (split reads). Gene and exon count matrices are generated using annotation information providing the gene (green boxes) and exon (blue boxes) coordinates together with the base-level coverage curve. The reads spanning exon-exon junctions (jx) are used to compute a third count matrix that might include unannotated junctions (jx 3 and 4). Without using annotation information, expressed regions (orange box) can be determined from the base-level coverage curve to then construct data-driven count matrices.", echo = FALSE}
8+
knitr::include_graphics("images/recountWorkflow_Figure1.png")
9+
```
10+
11+
## Human
12+
13+
Annotations:
14+
15+
* Gencode v26
16+
* Gencode v29
17+
* RefSeq
18+
* FANTOM6_cat
19+
* ERCC
20+
* SIRV
21+
22+
## Mouse

02_data.Rmd

-5
This file was deleted.
File renamed without changes.

03_explore.Rmd

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Study explorer
2+
3+
We can embed `shiny` web applications here

04_explore.Rmd

-2
This file was deleted.

04_qc.Rmd

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# (PART) Details {-}
2+
3+
# Quality check fields
4+
File renamed without changes.

05_qc.Rmd

-2
This file was deleted.

06_raw_files.Rmd

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Raw files
2+
3+
Explain the raw file formats we have and how they are organized
4+
5+
## Data source vs collection
File renamed without changes.

07_raw_files.Rmd

-1
This file was deleted.

09_software.Rmd 08_software.Rmd

File renamed without changes.

10_analysis.Rmd 09_analysis.Rmd

File renamed without changes.

10_process_data.Rmd

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# (PART) Expand `ReCount` {-}
2+
3+
# Your data
4+
5+
## Process your data
6+
7+
Info on how to use `recount-pump` for your own data
8+
9+
10+
## Contribute your collections
11+
12+
How to build a collection and send that information to us
13+

11_join_us.Rmd

+12-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
# Join the `ReCount` team!
1+
# Join the `ReCount` team!
2+
3+
We have multiple **positions available**! The `ReCount` project involves the Hansen, Leek, Langmead and Battle labs at JHU & the Nellore lab at OHSU & the Collado-Torres lab at LIBD.
4+
5+
Contact:
6+
7+
* [Kasper D. Hansen](www.hansenlab.org)
8+
* [Ben Langmead](www.langmead-lab.org/)
9+
* [Leonardo Collado-Torres](https://lcolladotor.github.io/)
10+
* [Abhinav Nellore](nellore.bio/)
11+
* [Alexis Battle](battlelab.jhu.edu/)
12+
* [Jeff Leek](jtleek.com/)

images/recountWorkflow_Figure1.png

7.28 KB
Loading

index.Rmd

+43-23
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ output:
77
bookdown::gitbook: default
88
---
99

10-
# Overview
10+
# Overview {-}
1111

1212
Welcome to the home of the `recount3` project! This website is the home to the most updated version of all the documentation related to the `recount3` project.
1313

@@ -17,52 +17,52 @@ The raw sequencing data were processed with [`recount-pump`](https://github.com/
1717

1818
By taking care of several preprocessing steps and combining many datasets into one easily-accessible website, we make finding and analyzing RNA-seq data considerably more straightforward.
1919

20+
## Related `recount3` websites {-}
2021

21-
## How to cite `recount3`
22+
`recount3` is composed of several related software tools and websites. Here is the full list, with all of them referring to this website for their unified documentation.
23+
24+
* [`recount-pump`](https://github.com/langmead-lab/recount-pump/): TODO
25+
* `recount-unifier`: TODO
26+
* `monorail`: TODO
27+
* `megadepth`: TODO
28+
* `recount3`: R package [source](https://github.com/LieberInstitute/recount3), Bioconductor [landing page](https://bioconductor.org/packages/recount3), `pkgdown` documentation [website](https://LieberInstitute.github.io/recount3)
29+
* [`recount3-docs`](https://github.com/LieberInstitute/recount3-docs): the source code for this documentation [website](https://LieberInstitute.github.io/recount3-docs).
30+
31+
32+
33+
## How to cite `recount3` {-}
2234

2335
Thank you for your continued support of the `ReCount` family of projects! We greatly appreciate you citing our work.
2436

25-
```{r}
37+
```{r "citation"}
2638
print(citation("recount3")[2], bibtex = TRUE)
2739
```
2840

29-
### Related projects
41+
### Related projects {-}
3042

3143
The `ReCount` project has three main publications over the years with implementation details that have been improved each time. Each phase of the project has had several companion publications that expanded the main resource in different directions. Please cite the appropriate expansions and results as you see relevant for your work.
3244

33-
### Previous `ReCount` projects
45+
### Previous `ReCount` projects {-}
3446

3547
* [`recount2`](https://jhubiostatistics.shinyapps.io/recount/)
3648
* [`ReCount`](http://bowtie-bio.sourceforge.net/recount/)
3749

38-
### Related publications
50+
### Related publications {-}
3951

40-
#### `recount3`
52+
#### `recount3` {-}
4153

42-
#### `recount2`
54+
#### `recount2` {-}
4355

44-
#### `ReCount`
56+
#### `ReCount` {-}
4557

46-
## Related `recount3` websites
47-
48-
`recount3` is composed of several related software tools and websites. Here is the full list, with all of them referring to this website for their unified documentation.
49-
50-
* [`recount-pump`](https://github.com/langmead-lab/recount-pump/): TODO
51-
* `recount-unifier`: TODO
52-
* `monorail`: TODO
53-
* `megadepth`: TODO
54-
* `recount3`: R package [source](https://github.com/LieberInstitute/recount3), Bioconductor [landing page](https://bioconductor.org/packages/recount3), `pkgdown` documentation [website](https://LieberInstitute.github.io/recount3)
55-
* [`recount3-docs`]((https://github.com/LieberInstitute/recount3-docs): the source code for this documentation [website](https://LieberInstitute.github.io/recount3-docs).
56-
57-
58-
## Team members
58+
## Team members {-}
5959

6060
* [Christopher Wilks](https://github.com/) (the star behind `recount3`!)
6161
* [Leonardo Collado Torres](https://github.com/lcolladotor)
6262
* [Shijie Charles Zheng](https://github.com/)
6363

6464

65-
## Teams involved
65+
## Teams involved {-}
6666

6767
* [Ben Langmead's lab at JHU Computer Science](http://www.langmead-lab.org/)
6868
* [Kasper Daniel Hansen's lab at JHBSPH Biostatistics Department](https://www.hansenlab.org/)
@@ -76,3 +76,23 @@ The `ReCount` project has three main publications over the years with implementa
7676

7777

7878
This book was last updated on `r Sys.time()`.
79+
80+
## R session information {-}
81+
82+
Details on the R version used for making this book. The source code is available at [`lcolladotor/bioc_team_ds`](https://github.com/lcolladotor/bioc_team_ds).
83+
84+
```{r session_info_chunk, eval = FALSE}
85+
## Load the package at the top of your script
86+
library("sessioninfo")
87+
88+
## Reproducibility information
89+
print('Reproducibility information:')
90+
Sys.time()
91+
proc.time()
92+
options(width = 120)
93+
session_info()
94+
```
95+
96+
```{r session_info, echo = FALSE}
97+
<<session_info_chunk>>
98+
```

0 commit comments

Comments
 (0)