Commit 5b6356de authored by smorabit's avatar smorabit
Browse files

added hdWGCNA paper

parent 23288849
Loading
Loading
Loading
Loading
+20 −15
Original line number Diff line number Diff line
@@ -3,21 +3,27 @@

[![R](https://img.shields.io/github/r-package/v/smorabit/hdWGCNA)](https://github.com/smorabit/hdWGCNA/tree/dev)
[![ISSUES](https://img.shields.io/github/issues/smorabit/hdWGCNA)](https://github.com/smorabit/hdWGCNA/issues)
[![DOI](https://zenodo.org/badge/286864581.svg)](https://zenodo.org/badge/latestdoi/286864581)
[![Publication](https://img.shields.io/badge/publication-bioRxiv-dodgerblue)](https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1)
[![Stars](https://img.shields.io/github/stars/smorabit/hdWGCNA?style=social)](https://github.com/smorabit/hdWGCNA/)

hdWGCNA is an R package for performing weighted gene co-expression network analysis [(WGCNA)](https://horvath.genetics.ucla.edu/html/CoexpressionNetwork/Rpackages/WGCNA/) in high dimensional
data such as single-cell RNA-seq or spatial transcriptomics.
hdWGCNA is highly modular and can construct co-expression networks to facilitate multi-scale analysis
of cellular and spatial hierarchies. hdWGNCA identifies robust modules of inerconnected genes, and
provides biologicalcontext for these modules through various biological knowledge sources.
transcriptomics data such as single-cell RNA-seq or spatial transcriptomics.
hdWGCNA is highly modular and can construct co-expression networks across multi-scale
cellular and spatial hierarchies. hdWGNCA identifies robust modules of inerconnected genes, and
provides context for these modules through various biological knowledge sources.
hdWGCNA requires data formatted as [Seurat](https://satijalab.org/seurat/index.html) objects,
one of the most ubiquitous formats for single-cell data. Check out the [hdWGCNA in single-cell data tutorial](https://smorabit.github.io/hdWGCNA/articles/basic_tutorial.html) or the [hdWGCNA in spatial transcriptomics data tutorial](https://smorabit.github.io/hdWGCNA/articles/ST_basics.html) to get started.

**Note:** hdWGCNA is under active development, so you may run into errors and small typos. We welcome users to
write [GitHub issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue)
to, report bugs, ask for help and ask for potential enhancements. GitHub issues are
preferred to emailing the authors directly.
to report bugs, ask for help, and to request potential enhancements.

If you use hdWGCNA in your research, please cite the following papers:

* [Morabito et al. bioRxiv 2022](https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1)
* [Morabito & Miyoshi et al. Nature Genetics 2021](https://doi.org/10.1038/s41588-021-00894-z)



## Installation

@@ -60,18 +66,17 @@ devtools::install_github('smorabit/hdWGCNA', ref='dev')

## Suggested Reading

If you are unfamiliar with WGCNA, we suggest reading the original WGCNA publication:
Check out the hdWGCNA manuscript on bioRxiv, and our original description of applying WGCNA to single-nucleus RNA-seq data:

* [WGCNA: an R package for weighted correlation network analysis](https://doi.org/10.1186/1471-2105-9-559)
* [High dimensional co-expression networks enable discovery of transcriptomic drivers in complex biological systems](https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1)
* [Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer’s disease](https://doi.org/10.1038/s41588-021-00894-z)

There are a number of additional relevant publications for WGCNA and related algorithms
like Dynamic Tree Cut and Module Preservation analysis:

For additional reading, we suggest the original WGCNA publication and papers describing
relevant algorithms for co-expression network analysis:

* [WGCNA: an R package for weighted correlation network analysis](https://doi.org/10.1186/1471-2105-9-559)
* [Defining clusters from a hierarchical cluster tree: the Dynamic Tree Cut package for R](https://doi.org/10.1093/bioinformatics/btm563)
* [Eigengene networks for studying the relationships between co-expression modules](https://doi.org/10.1186/1752-0509-1-54)
* [Geometric Interpretation of Gene Coexpression Network Analysis](https://doi.org/10.1371/journal.pcbi.1000117)
* [Is My Network Module Preserved and Reproducible?](https://doi.org/10.1371/journal.pcbi.1001057)

Our original description of applying WGCNA to single-nucleus RNA-seq data:

* [Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer’s disease](https://doi.org/10.1038/s41588-021-00894-z)
+7 −0
Original line number Diff line number Diff line
@@ -161,6 +161,13 @@
<p><img src="figures/basic_tutorial/Zhou_featureplot_hMEs_selected_wide.png" width="500" height="500"></p>
</div>
<div class="section level3">
<h3 id="hdwgcna-in-spatial-transcriptomics-data">
<a href="ST_basics.html">hdWGCNA in spatial transcriptomics data</a><a class="anchor" aria-label="anchor" href="#hdwgcna-in-spatial-transcriptomics-data"></a>
</h3>
<p>This tutorial covers the essential functions to construct a co-expression network in spatial transcriptomics data with hdWGCNA.</p>
<p><img src="figures/ST_basics/spatial_clusters.png" width="500" height="500"></p>
</div>
<div class="section level3">
<h3 id="network-visualization">
<a href="network_visualizations.html">Network visualization</a><a class="anchor" aria-label="anchor" href="#network-visualization"></a>
</h3>
+9 −5
Original line number Diff line number Diff line
@@ -124,11 +124,15 @@
    </div>


    <p>Morabito S, Miyoshi E, Michael N, Shahin S, Martini AC, Head E, Silva J, Leavy K, Perez-Rosendahl M, Swarup V (2021).
“Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer’s disease.”
<em>Nature Genetics</em>, <b>53</b>, 1143–1155.
<a href="https://doi.org/10.1038/s41588-021-00894-z" class="external-link">https://doi.org/10.1038/s41588-021-00894-z</a>. 
</p>
    <p>Morabito et al. High dimensional co-expression networks enable discovery of transcriptomic drivers in complex biological systems. bioRxiv (2022) [hdWGCNA]</p>
    <pre>@Article{,
  title = {High dimensional co-expression networks enable discovery of transcriptomic drivers in complex biological systems},
  author = {Samuel Morabito and Emily Miyoshi and Neethu Michael and Saba Shahin and Alessandra Cadete Martini and Elizabeth Head and Justine Silva and Kelsey Leavy and Mari Perez-Rosendahl and Vivek Swarup},
  journal = {bioRxiv},
  year = {2022},
  url = {https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1},
}</pre>
    <p>Morabito and Miyoshi et al. Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer's disease. Nature Genetics (2021) [scWGCNA]</p>
    <pre>@Article{,
  title = {Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer’s disease},
  author = {Samuel Morabito and Emily Miyoshi and Neethu Michael and Saba Shahin and Alessandra Cadete Martini and Elizabeth Head and Justine Silva and Kelsey Leavy and Mari Perez-Rosendahl and Vivek Swarup},
+13 −10
Original line number Diff line number Diff line
@@ -141,8 +141,13 @@
<div class="page-header"><h1 id="high-dimensional-wgcna-">high dimensional WGCNA <img src="reference/figures/logo.png" align="right" height="20%" width="20%"><a class="anchor" aria-label="anchor" href="#high-dimensional-wgcna-"></a>
</h1></div>

<p>hdWGCNA is an R package for performing weighted gene co-expression network analysis <a href="https://horvath.genetics.ucla.edu/html/CoexpressionNetwork/Rpackages/WGCNA/" class="external-link">(WGCNA)</a> in high dimensional data such as single-cell RNA-seq or spatial transcriptomics. hdWGCNA is highly modular and can construct co-expression networks to facilitate multi-scale analysis of cellular and spatial hierarchies. hdWGNCA identifies robust modules of inerconnected genes, and provides biologicalcontext for these modules through various biological knowledge sources. hdWGCNA requires data formatted as <a href="https://satijalab.org/seurat/index.html" class="external-link">Seurat</a> objects, one of the most ubiquitous formats for single-cell data. Check out the <a href="https://smorabit.github.io/hdWGCNA/articles/basic_tutorial.html">hdWGCNA in single-cell data tutorial</a> or the <a href="https://smorabit.github.io/hdWGCNA/articles/ST_basics.html">hdWGCNA in spatial transcriptomics data tutorial</a> to get started.</p>
<p><strong>Note:</strong> hdWGCNA is under active development, so you may run into errors and small typos. We welcome users to write <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue" class="external-link">GitHub issues</a> to, report bugs, ask for help and ask for potential enhancements. GitHub issues are preferred to emailing the authors directly.</p>
<p>hdWGCNA is an R package for performing weighted gene co-expression network analysis <a href="https://horvath.genetics.ucla.edu/html/CoexpressionNetwork/Rpackages/WGCNA/" class="external-link">(WGCNA)</a> in high dimensional transcriptomics data such as single-cell RNA-seq or spatial transcriptomics. hdWGCNA is highly modular and can construct co-expression networks across multi-scale cellular and spatial hierarchies. hdWGNCA identifies robust modules of inerconnected genes, and provides context for these modules through various biological knowledge sources. hdWGCNA requires data formatted as <a href="https://satijalab.org/seurat/index.html" class="external-link">Seurat</a> objects, one of the most ubiquitous formats for single-cell data. Check out the <a href="https://smorabit.github.io/hdWGCNA/articles/basic_tutorial.html">hdWGCNA in single-cell data tutorial</a> or the <a href="https://smorabit.github.io/hdWGCNA/articles/ST_basics.html">hdWGCNA in spatial transcriptomics data tutorial</a> to get started.</p>
<p><strong>Note:</strong> hdWGCNA is under active development, so you may run into errors and small typos. We welcome users to write <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue" class="external-link">GitHub issues</a> to report bugs, ask for help, and to request potential enhancements.</p>
<p>If you use hdWGCNA in your research, please cite the following papers:</p>
<ul>
<li><a href="https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1" class="external-link">Morabito et al. bioRxiv 2022</a></li>
<li><a href="https://doi.org/10.1038/s41588-021-00894-z" class="external-link">Morabito &amp; Miyoshi et al. Nature Genetics 2021</a></li>
</ul>
<div class="section level2">
<h2 id="installation">Installation<a class="anchor" aria-label="anchor" href="#installation"></a>
</h2>
@@ -181,21 +186,19 @@
<div class="section level2">
<h2 id="suggested-reading">Suggested Reading<a class="anchor" aria-label="anchor" href="#suggested-reading"></a>
</h2>
<p>If you are unfamiliar with WGCNA, we suggest reading the original WGCNA publication:</p>
<p>Check out the hdWGCNA manuscript on bioRxiv, and our original description of applying WGCNA to single-nucleus RNA-seq data:</p>
<ul>
<li><a href="https://doi.org/10.1186/1471-2105-9-559" class="external-link">WGCNA: an R package for weighted correlation network analysis</a></li>
<li><a href="https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1" class="external-link">High dimensional co-expression networks enable discovery of transcriptomic drivers in complex biological systems</a></li>
<li><a href="https://doi.org/10.1038/s41588-021-00894-z" class="external-link">Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer’s disease</a></li>
</ul>
<p>There are a number of additional relevant publications for WGCNA and related algorithms like Dynamic Tree Cut and Module Preservation analysis:</p>
<p>For additional reading, we suggest the original WGCNA publication and papers describing relevant algorithms for co-expression network analysis:</p>
<ul>
<li><a href="https://doi.org/10.1186/1471-2105-9-559" class="external-link">WGCNA: an R package for weighted correlation network analysis</a></li>
<li><a href="https://doi.org/10.1093/bioinformatics/btm563" class="external-link">Defining clusters from a hierarchical cluster tree: the Dynamic Tree Cut package for R</a></li>
<li><a href="https://doi.org/10.1186/1752-0509-1-54" class="external-link">Eigengene networks for studying the relationships between co-expression modules</a></li>
<li><a href="https://doi.org/10.1371/journal.pcbi.1000117" class="external-link">Geometric Interpretation of Gene Coexpression Network Analysis</a></li>
<li><a href="https://doi.org/10.1371/journal.pcbi.1001057" class="external-link">Is My Network Module Preserved and Reproducible?</a></li>
</ul>
<p>Our original description of applying WGCNA to single-nucleus RNA-seq data:</p>
<ul>
<li><a href="https://doi.org/10.1038/s41588-021-00894-z" class="external-link">Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer’s disease</a></li>
</ul>
</div>
</div>
  </div>
@@ -231,7 +234,7 @@
<ul class="list-unstyled">
<li><a href="https://github.com/smorabit/hdWGCNA/tree/dev" class="external-link"><img src="https://img.shields.io/github/r-package/v/smorabit/hdWGCNA" alt="R"></a></li>
<li><a href="https://github.com/smorabit/hdWGCNA/issues" class="external-link"><img src="https://img.shields.io/github/issues/smorabit/hdWGCNA" alt="ISSUES"></a></li>
<li><a href="https://zenodo.org/badge/latestdoi/286864581" class="external-link"><img src="https://zenodo.org/badge/286864581.svg" alt="DOI"></a></li>
<li><a href="https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1" class="external-link"><img src="https://img.shields.io/badge/publication-bioRxiv-dodgerblue" alt="Publication"></a></li>
<li><a href="https://github.com/smorabit/hdWGCNA/" class="external-link"><img src="https://img.shields.io/github/stars/smorabit/hdWGCNA?style=social" alt="Stars"></a></li>
</ul>
</div>
+14 −2
Original line number Diff line number Diff line
citHeader("To cite scWGCNA in publications use:")
citHeader("To cite hdWGCNA in publications, please use:")

citEntry(
  entry    = "article",
  title    = "High dimensional co-expression networks enable discovery of transcriptomic drivers in complex biological systems",
  author   = "Samuel Morabito, Emily Miyoshi, Neethu Michael, Saba Shahin, Alessandra Cadete Martini, Elizabeth Head, Justine Silva, Kelsey Leavy, Mari Perez-Rosendahl, Vivek Swarup",
  journal  = "bioRxiv",
  year     = "2022",
  url      = "https://www.biorxiv.org/content/10.1101/2022.09.22.509094v1",
  textVersion = paste(
    "Morabito et al. High dimensional co-expression networks enable discovery of transcriptomic drivers in complex biological systems. bioRxiv (2022) [hdWGCNA]"
  )
)

citEntry(
  entry    = "Article",
@@ -11,6 +23,6 @@ citEntry(
  pages    = "1143–1155",
  url      = "https://doi.org/10.1038/s41588-021-00894-z",
  textVersion = paste(

    "Morabito and Miyoshi et al. Single-nucleus chromatin accessibility and transcriptomic characterization of Alzheimer's disease. Nature Genetics (2021) [scWGCNA]"
  )
)
Loading