---
title: "BMRBr Package"
author: "Xi Chen"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{BMRBr Package}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

BMRB File Downloader is a R package that allows user to download individual files from Biological Magnetic Resonance Data Bank (BMRB) by provide their file IDs.

## Usage:
### 1. Load the BMRBr package:
```{r, results='asis'}
library(BMRBr)
```

### 2. Download file from BMRB repo:
```{r,eval=FALSE}
bmrb_download(965, "/Users/download")
```

```{r,eval=FALSE}
bmrb_download(c(965, 966, 967), "/Users/download")
```


### 3. Get a list/table of files that are aviailable to downoad from BMRB repo:

```{r,eval=FALSE}
bmrb_list = collect_ids(to_list = TRUE)
bmrb_list[c(1:10),]
```

```{r,eval=FALSE}
bmrb_table = collect_ids(to_list = FALSE)
bmrb_table[c(1:10),]
```