GetPDB 1.0.1

Download Protein files from rcsb.org
Documentation 
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

# PDBget
[![Crates.io](https://img.shields.io/crates/v/GetPDB?logoColor=orange)](https://crates.io/crates/GetPDB)
[![license](http://img.shields.io/badge/license-Apache%20v2-green.svg)](https://gitlab.com/philippe_noel/pdbget/blob/master/LICENSE)  

**CLI program to download files from rcsb.org or PDBe**

## Installation

### Using Cargo
```bash
cargo install GetPDB
pdbget -v
```

### From sources
```bash
git clone https://gitlab.com/philippe_noel/pdbget.git
cd pdbget
cargo install --path
pdbget --help
```

## Usage
```bash
Get Protein files 1.0.1
Philippe Noel
Download Protein files on rcsb.org or pdbe

USAGE:
    pdbget [OPTIONS] <PDBs>...

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -o <Output>         Output folder where to store files [default: ./]
    -s <Server>         Server name where to download pdb files. 'rcsb', 'pdbe'.
                        Format for rcsb: 'fasta', 'pdb', 'pdbgz', 'cif', 'cifgz', 'xmlgz'.
                        Format for pdbe: 'fasta', 'pdb', 'pdbgz', 'cif', 'xml'.
                         [default: rcsb]
    -t <UriType>        File type to download. 'pdb', 'pdbgz', 'cif', 'cifgz', 'fasta', 'xml', 'xmlgz' [default: PDB]

ARGS:
    <PDBs>...    PDB identifiers
```
With the **-s option**, you can specify the server where download files. Possible server are:
- rcsb : [RCSB.org](https://www.rcsb.org/)
- pdbe : [PDBe](https://www.ebi.ac.uk/pdbe/)
Note that all formats are not available for all server. Check the table.

| Format | RCSB               | PDBe               |
|:------:|:------------------:|:------------------:|
| FASTA  | :heavy_check_mark: | :heavy_check_mark: |
| PDB    | :heavy_check_mark: | :heavy_check_mark: |
| PDBGZ  | :heavy_check_mark: | :heavy_check_mark: |
| CIF    | :heavy_check_mark: | :heavy_check_mark: |
| CIFGZ  | :heavy_check_mark: | :x:                |
| XML    | :x:                | :heavy_check_mark: |
| XMLGZ  | :heavy_check_mark: | :x:                |

With the **-t option**, you can specify the output file format. Possible format are:
- pdb : [PDB format](http://pdb101.rcsb.org/learn/guide-to-understanding-pdb-data/introduction)
- pdbgz : GZ compression of a PDB file
- cif : [CIF format](https://www.iucr.org/resources/cif)
- cifgz : GZ compression of a CIF file
- fasta : FASTA sequence(s) of the protein
- xml : GZ compression of an XML file (uncompress XML are not provide on rcsb.org)