Browse code

building website

EmmaDann authored on 10/11/2020 09:16:13
Showing 7 changed files

... ...
@@ -2,3 +2,6 @@
2 2
 ^\.Rproj\.user$
3 3
 ^doc$
4 4
 ^Meta$
5
+^_pkgdown\.yml$
6
+^docs$
7
+^pkgdown$
... ...
@@ -6,3 +6,4 @@ testGLMM.R
6 6
 inst/doc
7 7
 doc
8 8
 Meta
9
+docs
... ...
@@ -1,19 +1,25 @@
1 1
 # miloR
2 2
 R package implementation of milo for testing differentially abundant neighbourhoods
3 3
 
4
+![](./milo_schematic.png)
5
+Format: ![Alt Text](url)
6
+
4 7
 [![Build Status](https://travis-ci.com/MikeDMorgan/miloR.svg?branch=master)](https://travis-ci.com/MikeDMorgan/miloR)
5 8
 
6 9
 [![Coverage](https://codecov.io/gh/MikeDMorgan/miloR/branch/master/graph/badge.svg)](https://codecov.io/gh/MikeDMorgan/miloR)
7 10
 
8 11
 
9
-To install `miloR` directly from GitHub:
10
-
11
-```devtools::install_github("MikeDMorgan/miloR") ```
12
+---
13
+### Installation
12 14
 
13
-For questions please create a new issue in this repository.
15
+```
16
+## Install development version
17
+devtools::install_github("MikeDMorgan/miloR") 
18
+```
14 19
 
15 20
 Examples on how to use `miloR` can be found in the [vignettes directory](https://github.com/MikeDMorgan/miloR/tree/master/vignettes).
16 21
 
22
+---
17 23
 ### Example work flow
18 24
 An example of the `Milo` work flow to get started:
19 25
 
... ...
@@ -43,7 +49,10 @@ milo.design <- milo.design[milo.design$Freq > 0, ]
43 49
 milo.res <- testNhoods(milo.obj, design=~Condition, design.df=milo.design)
44 50
 head(milo.res)
45 51
 ```
52
+---
53
+### Support
46 54
 
55
+For any question or bug report please create a new issue in this repository.
47 56
 
48 57
 
49 58
 
50 59
new file mode 100644
51 60
new file mode 100644
52 61
Binary files /dev/null and b/milo_schematic.png differ
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Differential abundance testing with _Milo_"
2
+title: "Differential abundance testing with Milo"
3 3
 author:
4 4
   - Emma Dann
5 5
   - Mike Morgan
... ...
@@ -1,5 +1,5 @@
1 1
 ---
2
-title: "Differential abundance testing with _Milo_ - Mouse gastrulation example"
2
+title: "Differential abundance testing with Milo - Mouse gastrulation example"
3 3
 author:
4 4
   - Emma Dann
5 5
   - Mike Morgan