Skip to content

Commit a99cfd6

Browse files
committed
update readme
1 parent 5f8bb95 commit a99cfd6

File tree

10 files changed

+45
-42
lines changed

10 files changed

+45
-42
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.Rmd

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,22 @@ devtools::install_github("KlugerLab/LocalizedMarkerDetector")
4040
library("LocalizedMarkerDetector")
4141
```
4242

43+
## Docker Installation
44+
45+
Alternatively, we provide a Docker environment with LMD and all its dependencies pre-installed. The pre-built Docker image can be downloaded using:
46+
47+
``` bash
48+
docker pull ruiqi0130/lmd-rstudio:lastest
49+
```
50+
51+
and to run the docker container:
52+
53+
``` bash
54+
docker run -it --rm --name lmd -p 8029:8787 -v /data/:/data/ docker.io/ruiqi0130/lmd-rstudio:latest
55+
```
56+
57+
Here, change `/data:/data` to `<your_local_data_directory>:/data`. A rstudio will be on port 8029.
58+
4359
## Example tutorial
4460
Please check [LMD tutorial](https://KlugerLab.github.io/LocalizedMarkerDetector/articles/).
4561

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,25 @@ devtools::install_github("KlugerLab/LocalizedMarkerDetector")
3131
library("LocalizedMarkerDetector")
3232
```
3333

34+
## Docker Installation
35+
36+
Alternatively, we provide a Docker environment with LMD and all its
37+
dependencies pre-installed. The pre-built Docker image can be downloaded
38+
using:
39+
40+
``` bash
41+
docker pull ruiqi0130/lmd-rstudio:lastest
42+
```
43+
44+
and to run the docker container:
45+
46+
``` bash
47+
docker run -it --rm --name lmd -p 8029:8787 -v /data/:/data/ docker.io/ruiqi0130/lmd-rstudio:latest
48+
```
49+
50+
Here, change `/data:/data` to `<your_local_data_directory>:/data`. A
51+
rstudio will be on port 8029.
52+
3453
## Example tutorial
3554

3655
Please check [LMD

docs/index.html

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pkgdown_sha: ~
44
articles:
55
LMD_cross_comparison_demo: LMD_cross_comparison_demo.html
66
LMD_demo: LMD_demo.html
7-
last_built: 2025-04-23T01:01Z
7+
last_built: 2025-04-29T01:16Z
88
urls:
99
reference: https://github.com/KlugerLab/LocalizedMarkerDetector/reference
1010
article: https://github.com/KlugerLab/LocalizedMarkerDetector/articles

docs/sitemap.xml

Lines changed: 0 additions & 40 deletions
This file was deleted.

src/LocalizedMarkerDetector.so

4.07 KB
Binary file not shown.

src/RcppExports.o

1.57 KB
Binary file not shown.

src/fastKL.o

1.21 KB
Binary file not shown.

src/fastMatMult.o

1.28 KB
Binary file not shown.

0 commit comments

Comments
 (0)