Last updated: 2023-08-18

Checks: 2 0

Knit directory: gbcd-workflow/analysis/

This reproducible R Markdown analysis was created with workflowr (version 1.7.0). The Checks tab describes the reproducibility checks that were applied when the results were created. The Past versions tab lists the development history.


Great! Since the R Markdown file has been committed to the Git repository, you know the exact version of the code that produced these results.

Great! You are using Git for version control. Tracking code development and connecting the code version to the results is critical for reproducibility.

The results in this page were generated with repository version a78ffef. See the Past versions tab to see a history of the changes made to the R Markdown and HTML files.

Note that you need to be careful to ensure that all relevant files for the analysis have been committed to Git prior to generating the results (you can use wflow_publish or wflow_git_commit). workflowr only checks the R Markdown file, but you know if there are other scripts or data files that it depends on. Below is the status of the Git repository when the results were generated:


Untracked files:
    Untracked:  .DS_Store

Note that any generated files, e.g. HTML, png, CSS, etc., are not included in this status report because it is ok for generated content to have uncommitted changes.


These are the previous versions of the repository in which changes were made to the R Markdown (analysis/index.Rmd) and HTML (docs/index.html) files. If you’ve configured a remote Git repository (see ?wflow_git_remote), click on the hyperlinks in the table below to view the files as they were in that past version.

File Version Author Date Message
Rmd a78ffef YushaLiu 2023-08-18 Add installation instructions
html f0df13d YushaLiu 2023-08-18 Build site.
Rmd a788fb9 YushaLiu 2023-08-18 Update index.Rmd
html 3e5891c Peter Carbonetto 2023-08-09 Small fix to the overview page.
Rmd 8d6197d Peter Carbonetto 2023-08-09 workflowr::wflow_publish("index.Rmd")
html 0e2b9b8 Peter Carbonetto 2023-08-09 Built the overview page.
Rmd 167e536 Peter Carbonetto 2023-08-09 Updated the workflowr config.
Rmd db41a57 Peter Carbonetto 2023-08-09 Ran wflow_start().

Overview

This repository contains code and data resources to accompany our research paper:

Yusha Liu, Peter Carbonetto, Jason Willwerscheid, Scott A. Oakes, Kay F. Macleod, and Matthew Stephens (2023). Dissecting tumor transcriptional heterogeneity from single-cell RNA-seq data by generalized binary covariance decomposition. bioRxiv doi:10.1101/2023.08.15.553436.

We provide the following resources:

  1. A vignette that shows how to use GBCD to dissect tumor transcriptional heterogeneity through analysis of multi-tumor single-cell RNA-seq (scRNA-seq) data. We illustrate this using a head and neck squamous cell carcinoma (HNSCC) dataset analyzed in our research paper.

  2. The scripts that reproduce the results and figures presented in the research paper.

Installation instructions

Implementing GBCD requires installing the R packages ashr (version 2.2-54), ebnm (version 1.0-42) and flashier (version 0.2.50), which were previously developed by our lab. All the analyses in this research paper were performed in R (version 4.1.0).

Citing this work

If you find any material in this repository useful for your work, please cite our research paper.

License

All source code and software in this repository are made available under the terms of the MIT license.

What’s included in the git repository

See here for the source repository. This is what you will find in the repository:

├── analysis
├── code
├── docs
├── hnscc
├── pdac
└── simulations

Please note that running these scripts may give you results that are slightly different from those presented in the paper (which were generated much earlier), particularly the GBCD results, due to version updates of the model fitting algorithm. However, the conclusions reported in the paper remain unaffected.