README.Rmd

---
output:
  html_document:
    keep_md: yes
    toc: yes
---
```{r setup, echo=FALSE, message=FALSE}
knitr::opts_chunk$set(
  fig.retina=2,
  fig.width=6,
  fig.height=4
)
```

# Helical wheel plots in R

## Installation

```{r install, eval=FALSE}
# Until this package is on CRAN:
devtools::install_github("smsaladi/heliquest")
```

# Examples

```{r examples, fig.height=6}
library(heliquest)

draw_helical_wheel("LGGLMNN")

draw_helical_wheel("ACDEFGHIKLMNPQRSTVWY",
                   FactC = 0.05, FONT1 = 3, FONT2 = 5,
                   CEXFT = 1, CEXTEXT = 0.8,
                   FlFH = 0, ANGT = 100,
                   NBMIN = 18, NBM2 = 36, NBMAX = 54)

# Custom Angle and Hydrophobicity
draw_helical_wheel("ACDEFGHIKLMNPQRSTVWY",
                   FactC = 0.05, FONT1 = 3, FONT2 = 5,
                   CEXFT = 1, CEXTEXT = 0.8,
                   Ang = 30, Mom = 1,
                   FlFH = 0, ANGT = 100,
                   NBMIN = 18, NBM2 = 36, NBMAX = 54)
```