Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ramiromagno committed Oct 18, 2023
1 parent 157d93e commit 8ea3101
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 24 deletions.
6 changes: 2 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ knitr::opts_chunk$set(
```
# ensemblr <img src='man/figures/logo.png' align="right" height="138.5" />

[![Travis build status](https://travis-ci.org/ramiromagno/ensemblr.svg?branch=master)](https://travis-ci.org/ramiromagno/ensemblr)
[![CRAN status](https://www.r-pkg.org/badges/version/ensemblr)](https://CRAN.R-project.org/package=ensemblr)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Development version](https://img.shields.io/badge/devel-0.0.1-orange.svg)](https://github.com/ramiromagno/ensemblr)

The goal of `{ensemblr}` is to provide an R client to the [Ensembl REST API](https://rest.ensembl.org/).

Expand All @@ -29,7 +27,7 @@ You can install the current, **very** experimental version of `{ensemblr}` with:

``` r
# install.packages("remotes")
remotes::install_github("maialab/ensemblr")
remotes::install_github("ramiromagno/ensemblr")
```

## Cheatsheet
Expand Down
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,9 @@

# ensemblr <img src='man/figures/logo.png' align="right" height="138.5" />

[![Travis build
status](https://travis-ci.org/ramiromagno/ensemblr.svg?branch=master)](https://travis-ci.org/ramiromagno/ensemblr)
[![CRAN
status](https://www.r-pkg.org/badges/version/ensemblr)](https://CRAN.R-project.org/package=ensemblr)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![License:
MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Development
version](https://img.shields.io/badge/devel-0.0.1-orange.svg)](https://github.com/ramiromagno/ensemblr)

The goal of `{ensemblr}` is to provide an R client to the [Ensembl REST
API](https://rest.ensembl.org/).
Expand All @@ -27,7 +23,7 @@ You can install the current, **very** experimental version of

``` r
# install.packages("remotes")
remotes::install_github("maialab/ensemblr")
remotes::install_github("ramiromagno/ensemblr")
```

## Cheatsheet
Expand All @@ -45,12 +41,12 @@ get_ld_variants_by_window('rs123', genomic_window_size = 1L)
#> # A tibble: 6 × 6
#> species_name population variant_id1 variant_id2 r_squared d_prime
#> <chr> <chr> <chr> <chr> <dbl> <dbl>
#> 1 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs124 0.722 1.00
#> 2 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs114 0.475 0.703
#> 3 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs10239961 0.255 1.00
#> 4 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs12536724 0.255 1.00
#> 5 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs122 0.722 1.00
#> 6 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs115 0.721 1.00
#> 1 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs114 0.475 0.703
#> 2 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs10239961 0.255 1.00
#> 3 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs122 0.722 1.00
#> 4 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs115 0.721 1.00
#> 5 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs124 0.722 1.00
#> 6 homo_sapiens 1000GENOMES:phase_3:CEU rs123 rs12536724 0.255 1.00
```

## Contributors
Expand All @@ -71,10 +67,10 @@ PDB](https://www.rcsb.org/), used under

## Similar projects

- R package rensembl by [David Winter](http://david-winter.info/):
<https://github.com/dwinter/rensembl>
- Python package ensembl-rest by [Andrés
García](https://agargar.wordpress.com/):
<https://github.com/Ad115/EnsemblRest>
- Python package ensembl by [Katsuya Noguchi](https://twitter.com/kn):
<https://github.com/kn/ensembl>
- R package rensembl by [David Winter](http://david-winter.info/):
<https://github.com/dwinter/rensembl>
- Python package ensembl-rest by [Andrés
García](https://agargar.wordpress.com/):
<https://github.com/Ad115/EnsemblRest>
- Python package ensembl by [Katsuya Noguchi](https://twitter.com/kn):
<https://github.com/kn/ensembl>

0 comments on commit 8ea3101

Please sign in to comment.