Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
abretaud committed Mar 12, 2024
1 parent 07de05a commit d733cf2
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Here's how we manage annotations at BIPAA:

These tools can be install with pip:

```
```bash
pip install gogstools
```

Expand All @@ -30,22 +30,28 @@ Genes from the base annotation are replaced by overlapping apollo genes, preserv

It depends on 4 software that can be installed from conda like this:

```
```bash
conda create --name ogsmerger bedops==2.4.39 bedtools cufflinks bcbiogff
```

(pinning to bedops 2.4.39 as [version 2.4.40 broke the output of gff2bed](https://github.com/bedops/bedops/issues/244))

Then you can source the conda environment:

```
```bash
source activate ogsmerger
```

And run the script:
Install gogstools with pip inside the conda env:

```bash
pip install gogstools
```
$ python ogs_merge/ogs_merge -h

And run the script:

```bash
$ ogs_merge -h
usage: ogs_merge [-h] [-p PREVIOUS_GFF] [-d DELETED] [-o OUT_PREFIX]
genome ogs_name id_regex id_syntax base_gff apollo_gff

Expand Down Expand Up @@ -81,8 +87,8 @@ This script generates a GFF file, the transcript/cds/protein fasta files, a file
In gff2embl, there is a script to submit annotations to EBI ENA.
```
$ python gff2embl/gff2embl --h
```bash
$ gff2embl --h
usage: gff2embl [-h] -g GENOME -p PROTEINS -s SPECIES -d DESCRIPTION -e
EMAIL -j PROJECT [--ref_title REF_TITLE]
[--ref_journal REF_JOURNAL] [--ref_authors REF_AUTHORS]
Expand Down Expand Up @@ -135,19 +141,19 @@ optional arguments:
EBI are using a custom embl format with some exotic validation rules.
They provide a tool that performs validation of the produced embl file + automatically reformat some parts of embl files according to their rules.
After running gff2embl, you need to get the latest validator jar from https://mvnrepository.com/artifact/uk.ac.ebi.ena.sequence/embl-api-validator
After running gff2embl, you need to get the [latest validator jar](https://mvnrepository.com/artifact/uk.ac.ebi.ena.sequence/embl-api-validator)
Then run:
```
```bash
java -jar embl-api-validator-1.1.xxx.jar -fix -r ogs.embl
```
This will modify the `ogs.embl` file, be sure to keep a backup.
If you only want to validate the emb file without modifying it, run it wihout the -fix option:
```
```bash
java -jar embl-api-validator-1.1.xxx.jar -r ogs.embl
```
Expand Down

0 comments on commit d733cf2

Please sign in to comment.