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
@@ -24,7 +24,7 @@ Below are the steps to perform a production deploy of BioAPI.
24
24
- `deploy.resources.limits.memory`: By default, 6GB of memory is allocated for MongoDB. Modify this value if you need it.
25
25
- BioAPI Server:
26
26
- `MONGO_USER` and `MONGO_PASSWORD`: These variables are the username and password for BioAPI to access MongoDB. These credentials must be the same ones that were setfor the MongoDB server.
27
-
- `DEBUG`: By default, use `false` value. If you change this value to `true`, then BioAPI will be use the configuration fordatabase connection and ports for the API that you setin`config.txt` file.
27
+
- `DEBUG`: If you change this value to `true`, then BioAPI will be use the configuration fordatabase connection and ports for the API that you setinthe `config.txt` file. Default `false`.
28
28
3. (Optional) Optimize Mongo by changing the configuration in the `config/mongo/mongod.conf` file and uncommenting the reference in the `docker-compose.yml` and/or `docker-compose.dev.yml`.
29
29
4. Start up all the services with Docker Compose running `docker compose up -d` to check that It's all working, and read the instructions in the following section to import the genomics databases.
30
30
@@ -54,18 +54,18 @@ To import all databases in MongoDB:
54
54
55
55
Where "/path/to/" is the absolute path of the "bioapi_db-1.2.1.gz" file downloaded on step 1.
56
56
57
-
1. Start up the services again running `docker compose up -d`
57
+
1. Start up the services again by running `docker compose -f docker-compose.dev.yml up -d`
58
58
2. Go inside the container `docker container exec -it bio_api_mongo_db bash`
Where *\<user\>*, *\<pass\>* are the preconfigured credentials to MongoDB in the `docker-compose.yml` file. *bioapi_db-1.2.1.gz* is the file downloaded in the previous step. **Keep in mind that this loading process will import approximately *47 GB* of information into MongoDB, so it may take a while**.
65
+
Where *\<user\>*, *\<pass\>* are the preconfigured credentials to MongoDB in the `docker-compose.yml` file. *bioapi_db-1.2.1.gz* is the file downloaded in the previous step. **Remember that this loading process will import approximately *47 GB* of information into MongoDB, which may take a while**.
66
66
67
67
4. Stop services with the command `docker compose -f docker-compose.dev.yml down`
68
-
5. Rollup the changes in `docker-compose.dev.yml` file to remove the backup file from the `volumes` section. Restart all the services again.
68
+
5. Roll up the changes in the `docker-compose.dev.yml` file to remove the backup file from the `volumes` section. Restart all the services again.
69
69
70
70
71
71
### Manually import the different databases
@@ -122,18 +122,18 @@ Where *\<service\>* could be `nginx_bioapi`, `web_bioapi` or `mongo_bioapi`.
122
122
123
123
If new versions are released forthe genomic databases includedin BioAPI, you can update them by following the instructions below:
124
124
125
-
- For the "Metabolic pathways (ConsensusPathDB)", "Gene nomenclature (HUGO Gene Nomenclature Committee)", "Gene ontology (GO)", "Cancerrelated drugs (PharmGKB)","Gene information (from Ensembl and CiVIC)" and "Cancer and Actionable genes (OncoKB)" databases, it is not necessary to make any modifications to any script. This is because the datasets are automatically downloaded in their most up-to-date versions when the bash file foreach database is executed as describedin the **Manually import the different databases** section of this file.
125
+
- For the "Metabolic pathways (ConsensusPathDB)", "Gene nomenclature (HUGO Gene Nomenclature Committee)", "Gene ontology (GO)", "Cancer-related drugs (PharmGKB)","Gene information (from Ensembl and CiVIC)" and "Cancer and Actionable genes (OncoKB)" databases, it is not necessary to make any modifications to any script. This is because the datasets are automatically downloaded in their most up-to-date versions when the bash file foreach database is executed as describedin the **Manually import the different databases** section of this file.
126
126
**Important notes**:
127
127
- For OncoKB the download is not automatic since it requires registration, but the steps to download them manually are explained in the same section mentioned above.
128
128
- For RefSeq gene summaries, the R package [GeneSummary](https://bioconductor.org/packages/release/data/annotation/html/GeneSummary.html) is used. The update of the database will depend on the version that the package includes.
129
129
- For String the download is not automatic, but the steps to download them manually are explained in the same section mentioned above.
130
130
- If you need to update the "Gene expression (Genotype-Tissue Expression)" database, you should also follow the procedures in the section named above, but first you should edit the bash file as follows:
131
131
1. Modify the **gtex2mongodb.sh** file. Edit the variables *"expression_url"* and *"annotation_url"*.
132
-
1. In the *expression_url* variable, set the url corresponding to the GTEx "RNA-Seq Data" compressed file (gz compression). This file should contain the Gene TPMs values (Remember that Gene expression on the GTEx Portal are shown in Transcripts Per Million or TPMs).
133
-
1. In the *"annotation_url"* variable, set the url corresponding to the file that contains the annotated samples and allows finding the corresponding tissue typeforeach samplein the database.
132
+
1. In the *expression_url* variable, set the URL corresponding to the GTEx "RNA-Seq Data" compressed file (gzip compression). This file should contain the Gene TPMs values (Remember that Gene expressions on the GTEx Portal are shown in Transcripts Per Million or TPMs).
133
+
1. In the *"annotation_url"* variable, set the URL corresponding to the file that contains the annotated samples, and allow finding the corresponding tissue typeforeach samplein the database.
134
134
By default, GTEx is being used in its version [GTEx Analysis V8 (dbGaP Accession phs000424.v8.p2)](https://gtexportal.org/home/datasets#datasetDiv1)
135
135
136
-
**NOTE:** It is NOT necessary to drop the MongoDB database before upgrading (this applies to all databases).
136
+
**NOTE:** It is NOT needed to drop the MongoDB database before upgrading (this applies to all databases).
137
137
138
138
### Export image file from database
139
139
@@ -153,10 +153,10 @@ Finally, if you want to create a new image of MongoDB data, you can follow the f
153
153
# ...
154
154
```
155
155
156
-
Where "/path/in/your/computer" is the absolute path to the directory on your computer where the mongodb image will be created
156
+
Where "/path/in/your/computer" is the absolute path to the directory on your computer where the `mongodb` image will be created
157
157
3. Start up the services of BioAPI running `docker compose up -d`
158
158
4. Go inside the container `docker container exec -it bio_api_mongo_db bash`
0 commit comments