README.Rmd

---
output: 
  github_document:
    df_print: kable
---

# Minimum viable product (MVP): R package `glasgowcoma`

![GCS sketch](http://sketchymedicine.com/wp-content/uploads/2012/09/GCS.jpg)

R Programming 수강생 여러분들께

Glasgow Coma Scale을 참고하거나 간단한 계산을 할 수 있는 단순한 패키지입니다. ( [Minimum viable product](https://en.wikipedia.org/wiki/Minimum_viable_product) )

## 설치

설치는 다음과 같이 하면 됩니다.

```{r eval = FALSE}
install.packages("devtools")
devtools::install_github("shanmdphd/glasgowcoma")
```

## 실행

실행은 다음과 같이 하면 됩니다.

```{r, error = TRUE}
library(glasgowcoma)
glasgowComaScale

reportgcs() # Defualt argument
reportgcs(eye = 4, verbal = 4, motor = 4)
reportgcs(simplify = FALSE) # Full report
reportgcs(3, 3, 4, now = "2017-01-01 11:25", simplify = FALSE) # custom time
reportgcs(verbal = 2.5) # Error
reportgcs(verbal = "erlk") # Error
```

## 수정

CLI에서 `git clone https://github.com/shanmdphd/glasgowcoma.git` 하거나 오른쪽 위의 초록색 버튼을 클릭해서 zip파일을 다운로드 한 뒤 압축을 풀고 소스를 수정 할 수 있습니다.

`roxygen2` 패키지를 사용하면 문서 작업을 쉽게 할 수 있습니다.
각 함수의 앞에 `#'` 으로 시작하는 주석을 각각 달고 다음의 함수를 실행하면 `NAMESPACE`와 `Rd` 파일을 자동으로 고쳐줍니다. 
직접 Rd 파일을 수정하는 것보다 간소하다고 많은 사람들이 말하곤 합니다.

```r
library(roxygen2)
roxygenize()
```