README.md 1.72 KB
Newer Older
Michael Baudis's avatar
Readme    
Michael Baudis committed
1
Beacon queries and interface for the MongoDB based _arrayMap_ cancer genome repository.
Daniel Teixeira's avatar
Daniel Teixeira committed
2

Severine Duvaud's avatar
Severine Duvaud committed
3
4
The sutructure of the project is the following:

Daniel Teixeira's avatar
Daniel Teixeira committed
5

Severine Duvaud's avatar
Severine Duvaud committed
6
7
8
# mongo-queries:

Queries are contained inside the directory [mongo-queries](mongo-queries)
9
10
11
12
13
14
15
16
17
18

#### Download commands

The following command can be used to download a chunk of the _arrayMap_ dataset, e.g. to understand data structures.

```wget "http://arraymap.org/api/?db=arraymap&qcveto=1&api_out=samples&icdm_m=8,9&api_doctype=jsondata&randno=200" -O 200samples.json```

The next command would replace the current local _arrayMap_ instance with the downloaded file.

```mongoimport --drop --db arraymap --collection samples < 200samples.json --batchSize 1```
Severine Duvaud's avatar
Severine Duvaud committed
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

# beacon-app

The directory contains the Beacon application itself. 

The applcation is based on node and angular.

In order to run the application on your localhost, you need to have [npm](https://www.npmjs.com/ "Package manager for JavaScript") installed.

Then, run:

```
npm install
```

in order to get all the required Javascript packages (as listed in packa.json), and then:

```
npm start
```

You should also have a __arrayMap__ MongoDB running on your localhost, on port 27017.

This can be changed in:

```
app.js
```
the application container.

The structure of the project is the following:

#### bin

Contains the www script which is used by 

```
npm start
```

to start the server.

#### arraymap-beacon

Contains the implementation of the Beacon API. There is one sub-directory per API version.

#### test

Contains the functional tests (based on the [Chai](http://chaijs.com/ "Chai assertion library for node" ) assertion library).

#### public

Contains the scripts, CSS, images, HTML for the UI part.

#### routes

Contains the routing script.