generated from neurogenomics/templateR
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
51 lines (37 loc) · 1.15 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
---
title: ""
author: "`r rworkflows::use_badges()`"
date: "<h4>README updated: <i>`r format( Sys.Date(), '%b-%d-%Y')`</i></h4>"
output:
github_document
---
```{r, echo=FALSE, include=FALSE}
pkg <- read.dcf("DESCRIPTION", fields = "Package")[1]
title <- read.dcf("DESCRIPTION", fields = "Title")[1]
description <- read.dcf("DESCRIPTION", fields = "Description")[1]
URL <- read.dcf('DESCRIPTION', fields = 'URL')[1]
owner <- tolower(strsplit(URL,"/")[[1]][4])
```
## ``r pkg``: `r title`
`r description`
If you use ``r pkg``, please cite:
> `r utils::citation(pkg)$textVersion`
## Installation
```R
if(!require("remotes")) install.packages("remotes")
remotes::install_github("`r URL`")
library(`r pkg`)
```
## Documentation
### [Website](https://`r owner`.github.io/`r pkg`)
### [Getting started](https://`r owner`.github.io/`r pkg`/articles/`r pkg`)
<hr>
## Contact
### [Neurogenomics Lab](https://www.neurogenomics.co.uk/)
UK Dementia Research Institute
Department of Brain Sciences
Faculty of Medicine
Imperial College London
[GitHub](https://github.com/neurogenomics)
[DockerHub](https://hub.docker.com/orgs/neurogenomicslab)
<br>