Skip to content

Commit

Permalink
chore: update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
SzymonSzyszkowski committed Dec 6, 2024
1 parent 57c8a8e commit afe6932
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,34 @@ To see all available commands after installation run
gentroutils --help
```

### Updating gwas catalog metadata

To update gwas catalog metadata run folliwing command

```bash
gentroutils -vvv -q gs://ot_orchestration/tests/gentroutils/log.txt update-gwas-curation-metadata \
-f ftp://ftp.ebi.ac.uk/pub/databases/gwas/releases/latest/gwas-catalog-associations_ontology-annotated.tsv gs://ot_orchestration/tests/gentroutils/gwas-catalog-associations_ontology-annotated.tsv \
-f ftp://ftp.ebi.ac.uk/pub/databases/gwas/releases/latest/gwas-catalog-download-studies-v1.0.3.1.txt gs://ot_orchestration/tests/gentroutils/gwas-catalog-download-studies-v1.0.3.1.txt \
-f ftp://ftp.ebi.ac.uk/pub/databases/gwas/releases/latest/gwas-catalog-download-ancestries-v1.0.3.1.txt gs://ot_orchestration/tests/gentroutils/gwas-catalog-download-ancestries-v1.0.3.1.txt \
-g https://www.ebi.ac.uk/gwas/api/search/stats
```

The command `update-gwas-curation-metadata` fetches the data from the ftp server and transfers them to the gcp without intermediate temporary files. The download(s) and upload(s) are made asyncronously.

The logs from the command are saved under the `-q` log file, if specified `gcp` log file, then the file will be uploaded after the command has run.

To test the command run it with `-d` == `--dry-run`, this will just mark the input and output destinations.
To allow for full logs to be transmitted to the log file, use `-vvv` to increase the verbosity of the logs

> [!NOTE]
> Change the path to the output `gcp` files to make sure they are saved under requested path
> [!WARNING]
> Please read before running the command!:
>
> * The above command has some default values set for the input and output files, make sure you test them in `--dry-run` so the existing files will not get overwritten!
> * Make sure to run `gcloud auth application-default login` to allow to use Google Cloud Python SDK before running the command
## Contribute

To be able to contribute to the project you need to set it up. This project
Expand Down

0 comments on commit afe6932

Please sign in to comment.