-
Notifications
You must be signed in to change notification settings - Fork 13
/
CaRpools-SHORTGUIDE-VirtualBox.Rmd
78 lines (48 loc) · 4.08 KB
/
CaRpools-SHORTGUIDE-VirtualBox.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
71
72
73
74
75
76
---
output:
html_document: default
---
# Installing caRpools Virtual Appliance Image
In this tutorial we will show you how to install and configure the caRpools virtual appliance into the open-source virtualization software VirtualBox. CaRpools is delivered using the ovf format which can also be used by other virtualization products such as Parallels or VMWare.
**Please note:** We advise you to use **VirtualBox Version 5.0.0.r101573**
* First install VirtualBox version _5.0.0.r101573_ from [here](https://www.virtualbox.org/wiki/Download_Old_Builds_5_0)
* Now download the official __caRpools virtual appliance__ from [here](http://www.dkfz.de/signaling/caRpools/caRpools-64bit-Appliance.zip) (1.8 GB)
* extract the downloaded file caRpools-64bit-Appliance.zip (by double-clicking on the icon)
```bash
MD5 Hash of caRpools-64bit-Appliance.zip: e8c5c2972ccca414f52584b8d7992485
```
* The extracted file will be called _caRpools-64bit-Appliance.ova_, double-click on it to start the import into VirtualBox
* Next you will be asked to configure your virtual machine. __Leave everything standard other than the RAM.__ Here you should provide a number which should be roughly 50% to 75% of your systems available RAM. So if you have 8GB RAM I would go for 4GB to a maximum of 6GB of RAM. The more RAM the better but if it is too much your host system can get really slow and unresponsive. Also tick the "Reinitalize the MAC address of all network cards here". When finished click on "Import".
* The actual import will take some time, so please be patient.
* When the import is finished, select the virtual machine in the main menu and click on the Start button
* after the virtual machine has loaded login the system using **username: crispr**, **password: cas**.
* There you are! The system will automatically load RStudio where you can start to work with caRpools
### Make a test run
Having started RStudio it should automatically load the CaRpools-testpackage project. If this is not the case, please double-click on the icon called **start-CaRpools-project** on your desktop.
Now type in the following commands into the console to run the test
```R
library(caRpools)
use.caRpools()
```
Depending on your host computer and amount of RAM you declared for this virtual machine the analysis will take some time, so please be patient.
The final result will be a PDF file called CaRpools-extended-PDF.pdf in the folder desktop/CarPools-testpackage as well as additional excel files and a subfolder with the generated images.
## Applying your own Data
You can of course use your own data, the caRpools testpackage is just meant as a start so you can make sure everything is already setup to work.
Just follow these steps:
* Copy your data files (see CaRpools-MANUAL.pdf for further information) to the __data__ folder
* Copy the MIACCS.xls to your computer and edit the file as described in the CaRpools Manual or the __[CaRpools-SHORTGUIDE-Usage](https://github.com/boutroslab/caRpools/blob/master/docs/CaRpools-SHORTGUIDE-Usage.Rmd)__
* After editing the MIACCS file with all necessary information, please make sure both filenames and folder paths are correct
* For the standard extended PDF report start CaRpools with `use.caRpools()`
* In case you want the other reports, `use.caRpools(file="TEMPLATE.Rmd")` with the other provided templates, that are _CaRpools-extended-HTML.Rmd_ (extended HTML version), _CaRpools-PDF.Rmd_ or _CaRpools-HTML.Rmd_ (both standard versions)
### How to copy data from and to the virtual machine?
* starting with Virtualbox 5 dragging and dropping files from the virtual desktop to your local desktop and vice versa is supported.
* To enable it on your machine you have to go to Virtualbox menu ->Device ->Drag and Drop->tick Bidirectional