Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
Al-Murphy committed Aug 7, 2024
1 parent e1d6289 commit 6bc29ca
Show file tree
Hide file tree
Showing 152 changed files with 24,876 additions and 44 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: MungeSumstats
Type: Package
Title: Standardise summary statistics from GWAS
Version: 1.13.3
Version: 1.13.4
Authors@R:
c(person(given = "Alan",
family = "Murphy",
Expand Down
20 changes: 9 additions & 11 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ knitr::opts_chunk$set(tidy = FALSE,
<!-- badges: start -->
`r badger::badge_bioc_release(color = "black")`
`r badger::badge_github_version(color = "black")`
`r badger::badge_github_actions(action = "rworkflows")`
`r badger::badge_last_commit(branch = "master")`
`r badger::badge_codecov(branch = "master")`
`r badger::badge_bioc_download(by = "total", color = "blue")`
`r badger::badge_license()`
`r badger::badge_doi(doi = "https://doi.org/10.1093/bioinformatics/btab665", color="blue")`
<!-- badges: end -->
<!--`r badger::badge_github_actions(action = "rworkflows")`-->
<!--``r badger::badge_codecov(branch = "master")` -->

# Introduction

The `MungeSumstats` package is designed to facilitate the standardisation of GWAS summary statistics as utilised in our Nature Genetics paper [@Skene2018].
The `MungeSumstats` package is designed to facilitate the standardisation of GWAS summary statistics.

## Overview

Expand All @@ -57,7 +57,7 @@ statistics.
# Installing `MungeSumstats`

`MungeSumstats` is available on
[Bioconductor](https://bioconductor.org/packages/MungeSumstats) (≥v3.13).
[Bioconductor](https://bioconductor.org/packages/MungeSumstats).
To install `MungeSumstats` on Bioconductor run:

```R
Expand Down Expand Up @@ -100,20 +100,20 @@ build, MungeSumstats can also infer this information from your data.

# Getting started

See the [Getting started vignette website](https://neurogenomics.github.io/MungeSumstats/articles/MungeSumstats.html)
See the [Getting started vignette website](https://al-murphy.github.io/MungeSumstats/articles/MungeSumstats.html)
for up-to-date instructions on usage.

See the [OpenGWAS vignette website](https://neurogenomics.github.io/MungeSumstats/articles/OpenGWAS.html)
See the [OpenGWAS vignette website](https://al-murphy.github.io/MungeSumstats/articles/OpenGWAS.html)
for information on how to use MungeSumstats to access, standardise and perform
quality control on GWAS Summary Statistics from the MRC IEU [Open GWAS Project](https://gwas.mrcieu.ac.uk/).

If you have any problems please do file an [Issue](https://github.com/neurogenomics/MungeSumstats/issues) here on GitHub.
If you have any problems please do file an [Issue](https://github.com/al-murphy/MungeSumstats/issues) here on GitHub.

# Future Enhancements

The `MungeSumstats` package aims to be able to handle the most common
summary statistic file formats including VCF. If your file can not be
formatted by `MungeSumstats` feel free to report the [Issue](https://github.com/neurogenomics/MungeSumstats/issues)
formatted by `MungeSumstats` feel free to report the [Issue](https://github.com/al-murphy/MungeSumstats/issues)
on GitHub along with your summary statistics file header.

We also encourage people to edit the code to resolve their particular issues
Expand All @@ -127,7 +127,7 @@ NSTUDY, INFO or FRQ,
```

Feel free to update the `data("sumstatsColHeaders")` following the
approach in the *data.R* file and add your mapping. Then use a [Pull Request](https://github.com/neurogenomics/MungeSumstats/pulls) on
approach in the *data.R* file and add your mapping. Then use a [Pull Request](https://github.com/al-murphy/MungeSumstats/pulls) on
GitHub and we will incorporate this change into the package.

# Contributors
Expand All @@ -144,5 +144,3 @@ development:
* [Mykhaylo Malakhov](https://github.com/MykMal)
* [Alasdair Warwick](https://github.com/rmgpanw)
* [Ao Lu](https://github.com/leoarrow1)

# References
46 changes: 14 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,27 @@
<i>Authors</i>: Alan Murphy, Brian Schilder and Nathan Skene
</h5>
<h5>
<i>Updated</i>: Apr-24-2024
<i>Updated</i>: Aug-07-2024
</h5>

<!-- Readme.md is generated from Readme.Rmd. Please edit that file -->
<!-- badges: start -->

[![](https://img.shields.io/badge/release%20version-1.10.1-black.svg)](https://www.bioconductor.org/packages/MungeSumstats)
[![](https://img.shields.io/badge/devel%20version-1.11.10-black.svg)](https://github.com/neurogenomics/MungeSumstats)
[![R build
status](https://github.com/neurogenomics/MungeSumstats/workflows/rworkflows/badge.svg)](https://github.com/neurogenomics/MungeSumstats/actions)
[![](https://img.shields.io/badge/devel%20version-1.13.4-black.svg)](https://github.com/neurogenomics/MungeSumstats)
[![](https://img.shields.io/github/last-commit/neurogenomics/MungeSumstats.svg)](https://github.com/neurogenomics/MungeSumstats/commits/master)
[![](https://codecov.io/gh/neurogenomics/MungeSumstats/branch/master/graph/badge.svg)](https://codecov.io/gh/neurogenomics/MungeSumstats)
[![](https://img.shields.io/badge/download-15314/total-blue.svg)](https://bioconductor.org/packages/stats/bioc/MungeSumstats)
[![](https://img.shields.io/badge/download-19161/total-blue.svg)](https://bioconductor.org/packages/stats/bioc/MungeSumstats)
[![License:
Artistic-2.0](https://img.shields.io/badge/license-Artistic--2.0-blue.svg)](https://cran.r-project.org/web/licenses/Artistic-2.0)
[![](https://img.shields.io/badge/doi-https://doi.org/10.1093/bioinformatics/btab665-blue.svg)](https://doi.org/https://doi.org/10.1093/bioinformatics/btab665)
<!-- badges: end -->
<!--[![R build status](https://github.com/neurogenomics/MungeSumstats/workflows/rworkflows/badge.svg)](https://github.com/neurogenomics/MungeSumstats/actions)-->
<!--`[![](https://codecov.io/gh/neurogenomics/MungeSumstats/branch/master/graph/badge.svg)](https://codecov.io/gh/neurogenomics/MungeSumstats) -->

# Introduction

The `MungeSumstats` package is designed to facilitate the
standardisation of GWAS summary statistics as utilised in our Nature
Genetics paper<sup>1</sup>.
standardisation of GWAS summary statistics.

## Overview

Expand Down Expand Up @@ -58,8 +56,8 @@ as well as:
# Installing `MungeSumstats`

`MungeSumstats` is available on
[Bioconductor](https://bioconductor.org/packages/MungeSumstats)
(≥v3.13). To install `MungeSumstats` on Bioconductor run:
[Bioconductor](https://bioconductor.org/packages/MungeSumstats). To
install `MungeSumstats` on Bioconductor run:

``` r
if (!require("BiocManager")) install.packages("BiocManager")
Expand Down Expand Up @@ -104,25 +102,25 @@ your data.
# Getting started

See the [Getting started vignette
website](https://neurogenomics.github.io/MungeSumstats/articles/MungeSumstats.html)
website](https://al-murphy.github.io/MungeSumstats/articles/MungeSumstats.html)
for up-to-date instructions on usage.

See the [OpenGWAS vignette
website](https://neurogenomics.github.io/MungeSumstats/articles/OpenGWAS.html)
website](https://al-murphy.github.io/MungeSumstats/articles/OpenGWAS.html)
for information on how to use MungeSumstats to access, standardise and
perform quality control on GWAS Summary Statistics from the MRC IEU
[Open GWAS Project](https://gwas.mrcieu.ac.uk/).

If you have any problems please do file an
[Issue](https://github.com/neurogenomics/MungeSumstats/issues) here on
[Issue](https://github.com/al-murphy/MungeSumstats/issues) here on
GitHub.

# Future Enhancements

The `MungeSumstats` package aims to be able to handle the most common
summary statistic file formats including VCF. If your file can not be
formatted by `MungeSumstats` feel free to report the
[Issue](https://github.com/neurogenomics/MungeSumstats/issues) on GitHub
[Issue](https://github.com/al-murphy/MungeSumstats/issues) on GitHub
along with your summary statistics file header.

We also encourage people to edit the code to resolve their particular
Expand All @@ -135,8 +133,8 @@ github. If your summary statistic file headers are not recognised by

Feel free to update the `data("sumstatsColHeaders")` following the
approach in the *data.R* file and add your mapping. Then use a [Pull
Request](https://github.com/neurogenomics/MungeSumstats/pulls) on GitHub
and we will incorporate this change into the package.
Request](https://github.com/al-murphy/MungeSumstats/pulls) on GitHub and
we will incorporate this change into the package.

# Contributors

Expand All @@ -152,19 +150,3 @@ We would like to acknowledge all those who have contributed to
- [Mykhaylo Malakhov](https://github.com/MykMal)
- [Alasdair Warwick](https://github.com/rmgpanw)
- [Ao Lu](https://github.com/leoarrow1)

# References

<div id="refs" class="references csl-bib-body" line-spacing="2">

<div id="ref-Skene2018" class="csl-entry">

<span class="csl-left-margin">1.
</span><span class="csl-right-inline">Nathan G. Skene, T. E. B., Julien
Bryois. Genetic identification of brain cell types underlying
schizophrenia. *Nature Genetics* (2018).
doi:[10.1038/s41588-018-0129-5](https://doi.org/10.1038/s41588-018-0129-5)</span>

</div>

</div>
121 changes: 121 additions & 0 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6bc29ca

Please sign in to comment.