Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding a logo? #593

Closed
wants to merge 12 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 3 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ output: github_document

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, child='index.md'}
<img src="man/figures/logo.svg" align="right" alt="" width="150" />

```{r, child='pkgdown/index.md'}
```

<!-- Additional content -->
Expand Down
46 changes: 18 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,36 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

<img src="man/figures/logo.svg" align="right" alt="" width="150" />


# Mendelian randomization with GWAS summary data

<!-- badges: start -->

[![R-CMD-check](https://github.com/MRCIEU/TwoSampleMR/actions/workflows/check-full.yaml/badge.svg)](https://github.com/MRCIEU/TwoSampleMR/actions/workflows/check-full.yaml)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![DOI](https://zenodo.org/badge/49515156.svg)](https://zenodo.org/badge/latestdoi/49515156)
[![Codecov test
coverage](https://codecov.io/gh/MRCIEU/TwoSampleMR/branch/master/graph/badge.svg)](https://app.codecov.io/gh/MRCIEU/TwoSampleMR?branch=master)
[![TwoSampleMR status
badge](https://mrcieu.r-universe.dev/badges/TwoSampleMR)](https://mrcieu.r-universe.dev/TwoSampleMR)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![DOI](https://zenodo.org/badge/49515156.svg)](https://zenodo.org/badge/latestdoi/49515156)
[![Codecov test coverage](https://codecov.io/gh/MRCIEU/TwoSampleMR/branch/master/graph/badge.svg)](https://app.codecov.io/gh/MRCIEU/TwoSampleMR?branch=master)
[![TwoSampleMR status badge](https://mrcieu.r-universe.dev/badges/TwoSampleMR)](https://mrcieu.r-universe.dev/TwoSampleMR)
<!-- badges: end -->

A package for performing Mendelian randomization using GWAS summary
data. It uses the [IEU OpenGWAS database](https://gwas.mrcieu.ac.uk/) to
obtain data automatically, and a wide range of methods to run the
analysis.
A package for performing Mendelian randomization using GWAS summary data. It uses the [IEU OpenGWAS database](https://gwas.mrcieu.ac.uk/) to obtain data automatically, and a wide range of methods to run the analysis.

## January 2020 major update
## January 2020 major update

**We have made substantial changes to the package, database and
reference panels.** For full details of the changes, please visit
<https://mrcieu.github.io/TwoSampleMR/articles/gwas2020.html>
**We have made substantial changes to the package, database and reference panels.** For full details of the changes, please visit <https://mrcieu.github.io/TwoSampleMR/articles/gwas2020.html>

## Installation

Users running Windows and macOS, to install the latest version of
TwoSampleMR please install from our MRC IEU r-universe
Users running Windows and macOS, to install the latest version of TwoSampleMR please install from our MRC IEU r-universe

``` r
```r
install.packages("TwoSampleMR", repos = c("https://mrcieu.r-universe.dev", "https://cloud.r-project.org"))
```

Users running Linux or WebR please see the [following
instructions](https://github.com/MRCIEU/mrcieu.r-universe.dev#readme).
Users running Linux or WebR please see the [following instructions](https://github.com/MRCIEU/mrcieu.r-universe.dev#readme).

To update the package run the same command again.

Expand All @@ -47,18 +41,14 @@ install.packages("remotes")
remotes::install_github("MRCIEU/TwoSampleMR")
```

To update the package just run the
`remotes::install_github("MRCIEU/TwoSampleMR")` command again.
To update the package just run the `remotes::install_github("MRCIEU/TwoSampleMR")` command again.

## Docker

A multi-platform docker image containing R with the TwoSampleMR package
pre-installed (for both x86_64 and ARM computers) is available here:
<https://hub.docker.com/r/mrcieu/twosamplemr>
A multi-platform docker image containing R with the TwoSampleMR package pre-installed (for both x86_64 and ARM computers) is available here: https://hub.docker.com/r/mrcieu/twosamplemr

<!-- Additional content -->

## Documentation

**Full documentation available here:**
<https://mrcieu.github.io/TwoSampleMR/>
**Full documentation available here:** https://mrcieu.github.io/TwoSampleMR/
102 changes: 102 additions & 0 deletions docs/404.html

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

72 changes: 72 additions & 0 deletions docs/LICENSE-text.html

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

Loading
Loading