Skip to content

Commit

Permalink
updating README.Rmd
Browse files Browse the repository at this point in the history
  • Loading branch information
Noushin Niknafs committed Sep 9, 2024
1 parent a7a681a commit ebe3fe2
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,45 @@ Here is an overview of the directory structure:

* output: This directory includes the results from training the ARTEMIS-DELFI model, and running the decifer analysis as R objects or text files.


The `docs` directory includes index.html, which contains links to the code and figures from the manuscript. You need to clone this repository and open this file to view it on your browser or
you can use this [link](https://cancer-genomics.github.io/brain_wflow) to view the results without cloning or rebuilding the analysis.

#### Installation Note

The package versions used in the repository are managed by [renv](https://rstudio.github.io/renv/articles/renv.html).
After cloning the repo and starting an R session in the project directory, renv will be downloaded and installed.
renv will print any conflicts between the installed package versions and the renv lock file.
Follow the suggestions printed to install the missing packages. The `renv::status()` function can be used to identify version conflicts between the repository and the installed packages,
while the `renv::restore()` function can be used to restore the versions used in the repository.

#### Getting Started

To reproduce the figures and tables in Mathios et al.

```{r mathios, eval=FALSE}
```{r build, eval=FALSE}
wflow_build("analysis/*.Rmd")
```


```{r publish, eval=FALSE, eval = FALSE}
wflow_publish("analysis/*.Rmd")
```

#### Preprocessing

Following list of READMEs explain the preprocessing steps, ARTEMIS-DELFI training and DECIFER analysis and mention any external data used (if any).

[Preprocessing](code/00-preprocess/README.md)

[rbrain](code/01-rbrain/README.md)

[ARTEMIS-DELFI](code/02-artemis-delfi/README.md)

[DECIFER](code/04-decifer/README.md)

#### Data

The data used in the analysis is deposited with EGA accession number XYZ.


0 comments on commit ebe3fe2

Please sign in to comment.