R 프로그래밍

R 사용과 프로그램 설계 우수 모범사례

1. 작성한 프로그램이 무엇인지 기술하는 코드로 시작한다:

# Sarah Supp, Tracy Teal, Jon Borelli 가 작성한 코드로,
# 2014년 과학논문에 사용한 분석과 그림을 모사하는 프로그램이다.

2. 가져오기(import) 문장(library)을 모두 실행한다:

library(ggplot2)
library(reshape)
library(vegan)

3. 스크립트를 얻어오기(source()) 전에 작업 디렉토리를 설정하건, R 을 해당 작업 디렉토리에서 시작한다:

setwd() 명령어를 사용해서 작업 디렉토리를 설정할 때 주의해야 된다. 스크립트에 디렉토리를 변경하면 제현 가능성(reproducibility)을 제한한다.

• 변경하려는 디렉토리가 존재하지 않거나, 사용자가 해당 디렉토리에 올바른 권한이 없는 경우 setwd() 명령어를 실행하면 오류가 난다. 특히, 디렉토리 구조가 서로 다른 사용자 간에 스크립트를 공유할 때 문제가 야기된다.
• 스크립트가 오류로 종료할 때 혹은 종료하면, 시작한 디렉토리와 다른 디렉토리에 최종 남겨지게 되고, 스크립트를 다시 호출하면, 더 큰 문제를 야기한다. setwd() 명령어를 사용하려면, 이러한 문제를 회피하고자 스크립트 상단에 setwd() 설정을 두는 것이 최선이다.

다음 오류 메시지를 통해서 R이 지정한 작업 디렉토리 설정에 실패했음을 나타낸다:

Error in setwd("~/path/to/working/directory") : cannot change working directory

스크립트를 실행하는 사용자는 본인 컴퓨터에서 연관성 있는 디렉토리에서 시작하고 나서, 상대 파일 경로를 사용하는 관례를 따르는 것을 고려한다(아래 참조).

4. # 혹은 #- 기호를 사용해서 코드를 구분하게 한다. 그럼으로써 쉽게 아래로 스크롤해서 원하는 것을 찾는다.

5. 하나 이상 함수가 있다면, 코드 상단에 배치한다. 그래서 처음으로 실행되는 것 중에 하나로 만든다. 많은 함수를 작성했다면, .R 파일에 모아 넣고, source 해서 불러온다. Source해서 불러오면 모든 함수가 정의되어 필요할 때마다 사용할 수 있다. 앞에서 언급된 이유로 source 해서 불로온 스크립트에 setwd(), (혹은 사용자 작업공간에 부작용을 갖는 다른 함수) 사용을 피한다.

source("my_genius_fxns.R")

6. 코드내에는 일관된 코딩 스타일을 준수한다.

7. 코드를 모듈로 관리한다. 함수 혹은 루프 한개가 너무 길어지면, 잘게 쪼개 조작내는 것을 고려한다.

8. 여러분이 직접 반복하지 않는다. 자동화하라! 다수 객체 혹은 파일에 동일한 코드가 반복되면, 루프 혹은 함수를 사용해서 같은 작업을 수행한다. 본인이 직접 반복하면 할수록, 실수를 할 가능성이 높아진다.

9. 동일한 디렉토리에 한 프로젝트에 대한 모든 소스 파일을 관리한다. 그리고 나서, 필요하면 상대경로를 사용한다. 예를 들어, 다음 상대경로는 사용하고,

dat <- read.csv(file = "/files/dataset-2013-01.csv", header = TRUE)

다음 절대경로 사용은 삼가한다:

dat <- read.csv(file = "/Users/Karthik/Documents/sannic-project/files/dataset-2013-01.csv", header = TRUE)

10. R에 메모리 이슈가 발생할 수 있다. 오랜 시간동안 R 스크립트를 사용한 후에 메모리 부족 상황은 흔한 문제다. R 세션 객체를 검사하는데, 객체 목록을 찾고, 현재 팩키지를 검색해서 사용되지 않는 객체를 제거한다. 쭉 이어진 집중적인 계산작업을 실행할 때 우수 모범사례는 해당 목적을 달성한 후 임시 객체는 제거하는 것이다. 종종 객체를 제거한 후에도 한동안 사용되지 않는 메모리가 말끔히 정리되지 않는 경우가 있다. gc() 명령어를 사용해서 강제로 R에 명령해서 메모리를 깔끔하게 정리한다.

interim_object <- data.frame(rep(1:100,10),rep(101:200,10),rep(201:300,10)) # 1,000 줄 표본 데이터셋
object.size(interim_object) # 객체에 할당된 메모리 크기를 보고한다.
rm(interim_object) # 특정 객체만 제거한다.
gc() # 더이상 사용되지 않는 메모리를 R로 하여금 강제로 해방시켜 사용할 수 있게 만든다.
ls()  # 현재 작업공간에 있는 모든 객체를 보여준다.
rm(list = ls()) # 작업공간에 있는 모든 객체를 삭제하고 새로운 상태로 시작한다.

11. 세션 이력(history)은 저장하지 않는다. (기본 디폴트 설정으로 R에서 RData 파일을 저장할 것인지 묻는다). 대신에, 깨끗한 환경에서 시작해서, 이전 객체가 현재 환경을 오염시키지 않게 만든다. 세션 이력을 저장하면, 다른 누군가의 컴퓨터에서 코드를 실행할 때 예상하지 못한 결과가 나올 수 있다.

12. 프로젝트 디렉토리 어딘가에 sessionInfo() 를 가능하면 기록해 둔다. 세션정보는 현재 프로젝트에 사용되는 모든 팩키지 정보를 간직하고 있기 때문에 매우 소중하다. 새로운 프로젝트 버젼으로 인해 함수 동작방식이 변경되면, 항상 거슬러 올라가 잘 동작했던 버젼을 재설치하면 된다. (주의: 최소한 CRAN 사이트에, 모든 이전 팩키지 버젼이 영구적으로 저장보관되어 있다).

13. 협업하라. 친구를 잡아서 “코드 검토(code review)”를 실습하라. 방법론과 논문작성에는 실제로 활용하는데, 코드에는 왜 하지 않는가? 코드는 사실 주된 과학 제품이며, 엄청난 노고의 결과물이다!

14. 버전 제어 시스템과 자주 갱신하면서 코드를 개발한다!