문서 예제

문서는 좋은 패키지의 가장 중요한 측면 중 하나입니다. 그것 없이, 사용자는 패키지를 사용 하는 방법을 알 수 없습니다. 설명서는 미래의 기능(함수가 수행해야 하는 작업을 기억함)과 패키지를 확장하는 개발자에게도 유용합니다. 모든 형태의 문서는 종종 형사 및 민사 소송에서 중요한 증거로 사용됩니다. 이러한 문서의 법의학 분석은 의문 문서 검사의 범위 내에 있습니다. 소송 중에 생성될 수 있는 많은 수의 문서를 카탈로그화하고 관리하기 위해 Bates 번호 매기기는 소송의 모든 문서에 적용되어 각 문서가 고유하고 임의적이며 식별 번호가 갖도록 합니다. S3 제네릭은 일반 함수이므로 문서화합니다. S3 클래스에는 형식정의가 없으므로 생성자 함수를 문서화합니다. S3 메서드를 문서화할지 여부는 사용자의 선택입니다.

print()와 같은 간단한 제네릭에 대한 메서드를 문서화할 필요가 없습니다. 그러나 방법이 더 복잡하거나 추가 인수가 포함되어 있는 경우 사람들이 어떻게 작동하는지 알 수 있도록 문서화해야 합니다. 기본 R에서는 predict.lm(), predict.glm(및 anova.glm)과 같은 보다 복잡한 방법에 대한 설명서 예제를 볼 수 있습니다. 문서는 비밀, 비공개 또는 공개로 분류되는 경우도 있습니다. 그들은 또한 초안 또는 증거로 설명 될 수있다. 문서를 복사하면 원본이 “원본”으로 표시됩니다. 문서는 정보의 한 형태입니다. 문서는 전자 양식에 넣고 하나 이상의 파일로 컴퓨터에 저장할 수 있습니다. 전체 문서 또는 개별 부품은 개별 데이터 항목으로 취급될 수 있습니다. 파일 또는 데이터로서 문서는 데이터베이스의 일부일 수 있습니다. 전자문서관리(EDM)는 전자적으로 저장된 문서의 관리를 다룹니다.

“간단한 문서”를 정의하는 부러워 할 수없는 작업을 수행에 대한 명예 사라 (예와 함께, 더 적은!). setClass() 전에 roxygen 블록을 추가하여 S4 클래스를 문서화합니다. @slot 사용하여 함수의 매개 변수를 설명하는 @param 사용하는 것과 동일한 방식으로 클래스의 슬롯을 문서화합니다. 다음은 간단한 예입니다: 문서는 생각의 서면, 그림, 제시 또는 기념 표현입니다. 문서는 생각의 라인을 훈련 하는 양식, 또는 기록 된 조각 또는 역사에서, 중요 한 이벤트. 이 단어는 “가르침” 또는 “교훈”을 의미하는 라틴어 다큐멘터리에서 유래되었습니다. 과거에는 일반적으로 진실이나 사실의 증거로 유용한 서면 증거를 나타내는 데 사용되었습니다.

Uncategorized