You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+63Lines changed: 63 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,69 @@ ArchR::installExtraPackages()
55
55
```
56
56
If any of these steps fails, you should identify the offending package and troubleshoot that individual installation before proceeding. Additionally, please see the ArchR website (www.ArchRProject.com) where we have installation troubleshooting tips.
57
57
58
+
# Pre-compiled ArchR environment
59
+
We provide two methods in which a user can manage R dependencies.
60
+
61
+
### Using renv to manage dependencies
62
+
The first is by using renv to manage a project's dependencies. To utilize this, make sure that the renv package is installed and loaded. Before you are ready to use `renv`, you must ensure that you are working on the same R version that we used for the provided renv environment.
63
+
The R versions we currently support are:
64
+
```
65
+
- R 4.4
66
+
- R 4.1
67
+
```
68
+
Secondly, make sure that the renv package is installed and loaded.
Now, we can initiate our renv project environment, utilizing the renv.lock to bootstrap a new renv environment.
89
+
```
90
+
renv::init()
91
+
```
92
+
93
+
### Using Docker to manage dependencies
94
+
We also provide Docker images, built off of `rocker/rstudio`, that already have ArchR and all dependencies pre-loaded.
95
+
96
+
The latest version can be found at:
97
+
```
98
+
greenleaf/archr:latest
99
+
```
100
+
and other versions, including images built with differing R versions, can be found at:
101
+
```
102
+
https://hub.docker.com/r/greenleaflab/archr/tags
103
+
```
104
+
105
+
To utilize these images, the user can first install Docker as mentioned in their [documentation](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
106
+
107
+
Following, create a container using the following command:
108
+
```
109
+
docker image pull immanuelazn/archr:latest
110
+
docker run -it --rm -v <your_workspace>:/workspace -p <your_port_of_interest>:8787
111
+
```
112
+
This will spin up a container that has Rstudio turned on by default. Rstudio can be accessed through:
113
+
```
114
+
localhost:<your_port_of_interest>
115
+
```
116
+
If you would like an interactive bash console instead, the following command can instead be called:
117
+
```
118
+
docker run -it --rm -v <your_workspace>:/workspace -p <your_port_of_interest>:8787 bash
119
+
```
120
+
58
121
# Issues using ArchR?
59
122
60
123
ArchR is currently in __beta__. We expect there to be bumps in the road. If you think you have found a bug, please first install the latest version of ArchR via
0 commit comments