generated from RajLabMSSM/echoverseTemplate
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
70 lines (51 loc) · 2.01 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
---
title: ""
author: "`r rworkflows::use_badges(add_doi = '10.1093/bioinformatics/btab658')`"
output:
github_document
---
```{r, echo=FALSE, include=FALSE}
pkg <- read.dcf("DESCRIPTION", fields = "Package")[1]
description <- read.dcf("DESCRIPTION", fields = "Description")[1]
```
## ``r pkg``: `r gsub("echoverse module: ","", description)`
This R package is part of the *echoverse* suite that supports [`echolocatoR`](https://github.com/RajLabMSSM/echolocatoR):
an automated genomic fine-mapping pipeline.
If you use ``r pkg``, please cite:
> `r citation(pkg)$textVersion`
## Installation
```R
if(!require("remotes")) install.packages("remotes")
remotes::install_github("RajLabMSSM/`r pkg`")
library(`r pkg`)
```
## Documentation
### [Website](https://rajlabmssm.github.io/`r pkg`)
### [Get started](https://rajlabmssm.github.io/`r pkg`/articles/`r pkg`)
## Name
<details>
<summary><strong>❓🦇❓ So what does <code>devoptera</code> mean, anyways?</strong> (click to find out)</summary>
[__DevOps__](https://en.wikipedia.org/wiki/DevOps) is a software engineering
methodology that is itself an amalgam of software **Dev**lopment and
IT **Op**eration**s**.
**Chiroptera** is a the name of the phylogenetic order to which bats belong.
`devoptera` is part of the broader *echoverse* suite that supports
[`echolocatoR`](https://github.com/RajLabMSSM/echolocatoR), and
`echolocatoR` is an R package that facilitates fine-mapping to pinpoint
causal genetic variants underlying complex traits.
You know, like bats do (kind of). :cricket::wavy_dash::bat:
</details>
<hr>
## Contact
<a href="https://bschilder.github.io/BMSchilder/" target="_blank">Brian
M. Schilder, Bioinformatician II</a>
<a href="https://rajlab.org" target="_blank">Raj Lab</a>
<a href="https://icahn.mssm.edu/about/departments/neuroscience" target="_blank">Department
of Neuroscience, Icahn School of Medicine at Mount Sinai</a>
# Session info
<details>
```{r Session Info}
devoptera::session_info()
```
</details>
<hr>