R Language
메타 : 문서 가이드 라인

비고

좋은 예제 만들기

Q & A에 대한 좋은 예 를 만들기 위한 지침의 대부분은 문서로 이어집니다.

• 최소한으로 만들고 요점을 찾으십시오. 합병증과 우울증은 비생산적입니다.

• 작업 코드와 그것을 설명하는 산문 모두 포함하십시오. 어느 쪽도 충분하지 않습니다.

• 데이터를 외부 소스에 의존하지 마십시오. 가능한 경우 데이터를 생성하거나 데이터 세트 라이브러리를 사용하십시오.

  library(help = "datasets")
  

문서 도구의 컨텍스트에는 몇 가지 추가 고려 사항이 있습니다.

• 관련이있을 때마다 ?data.frame 과 같은 내장 문서를 참조하십시오. SO Docs는 내장 된 문서를 대체하려는 시도가 아닙니다. 새로운 R 사용자가 내장 된 문서뿐만 아니라 문서를 찾는 방법을 알고 있는지 확인하는 것이 중요합니다.

• 여러 예제에 적용되는 내용을 Remarks 섹션으로 이동하십시오.

스타일

프롬프트

코드를 복사하여 붙여 넣을 수있게하려면 각 행의 처음에 R> , > 또는 + 와 같은 프롬프트를 제거하십시오. 일부 문서 작성자는 복사 붙여 넣기를 쉽게하지 않으려 고합니다. 괜찮습니다.

콘솔 출력

콘솔 출력은 코드와 명확하게 구분되어야합니다. 일반적인 접근 방식은 다음과 같습니다.

• 입력시 프롬프트 포함 (콘솔을 사용할 때 표시됨).
• # 또는 ## 로 각 출력을 주석으로 처리하십시오.
• 인쇄물은 그대로 출력물을 입력에서 돋보이게 만들기 위해 앞선 [1] 을 신뢰합니다.
• 코드와 콘솔 출력 사이에 빈 줄을 추가하십시오.

할당

= 와 <- 는 R 객체를 할당하는 데는 문제가 없습니다. , 구문 분석하기 어려운 코드를 작성하지 않도록 적절하게 공백을 사용하여 같은 x<-1 (모호한 사이에 x <- 1 및 x < -1 )

코드 주석

코드 자체의 목적과 기능을 설명해야합니다. 이 설명이 산문 또는 코드 주석에 있어야하는지에 대한 어떤 빠르고 어려운 규칙도 없습니다. 산문은 더 읽기 쉽고 더 긴 설명을 허용하지만 코드 주석은 더 쉽게 복사하여 붙여 넣을 수 있습니다. 두 가지 옵션을 염두에 두십시오.

섹션

많은 예제가 섹션을 필요로하지 않을만큼 짧지 만 사용하는 경우 H1 부터 시작하십시오.