2011-07-27 6 views
2

패키지를 생성하기 위해 처음에 package.skeleton을 실행 한 이후, 몇 가지 S3 클래스를 추가했습니다. 각 클래스에는 5-10 개의 메소드가 있습니다. 멋진 prompt 메모리에서로드 된 함수에서 .Rd 파일을 만드는 명령을 발견했지만 R이 자동으로 문서화 된 모든 여러 기능을 가진 단일 도움말 파일을 만들도록 할 수 있습니까? 나는 prompt의 향상된 버전과 같은 것을 생각하고 있는데, 여기에 함수 목록을 전달하면 도움말 파일에 추가 된 추가 정보 만있는 단일 .Rd 파일이 생성됩니다. 나는 duration라는 일반 및 방법 duration.bond(market,...), duration.account(market,time,...), duration.portfolio(market,...)가있는 클래스가있는 경우하나의 파일에 여러 개의 S3 메소드 자동 문서화

예를 들어, 내가 prompt\method{}를 포함하는 \usage 부와 market을 포함하는 \arguments{} 섹션의 도움말 파일을 만들고 싶습니다, \dots, time.

여기에 어떤 희망이 있습니까? 복사 및 붙여 넣기가 매우 힘들어지고 있습니다!

+0

bond(), account(), ...은 수업이 아니라 저에게 메소드/함수처럼 보입니다. 그들이 수업이라면 질문은 다소 혼란 스럽습니다 ... –

+0

그들은 특정 클래스의 객체를 만드는 함수입니다. 따라서 기간은 일반 사항이며 duration.bond, duration.account, duration.portfolio 메소드/함수가 있습니다. 하지만 두 번째 단락은 혼동 스럽네요. 다시 단어로 간다. –

+0

로마가 지적한 한 가지 가능성은 단지 ROxygen을 사용하는 것입니다. 앞으로의 프로젝트에서이 작업을 수행 할 것입니다. 그러나이 프로젝트를 위해 최선의 방법은 가장 많은 인수가있는 메소드를 선택하고 그것에 대해'prompt'를 사용하는 것입니다. 그러나 가장 우아한 방법은 아닙니다. –

답변

1

가장 완벽한 인수를 가진 메소드를 선택하고 프롬프트를 사용하기 위해 내가 선택한 것을 여기에 추가 한 다음 다른 메소드를 수동으로 동일한 도움말 파일에 추가하십시오.

다른 대안은 Rd2roxygen을 사용하여 이미 .Rd에있는 모든 것을 Roxygen으로 변환 한 다음 전체 프로젝트에 Roxygen을 사용하는 것이 었습니다. 이것은 다음 릴리스에서 내가 수행 할 가능성이 높습니다.

0

당신은 롤 - 네 - 자신의 수 다음을 통해 (다시 밖으로 파일에 결과를 기록, 각각의 특정 경우 (pastegsub의 현명한 사용)에 맞게 편집을 한 후, (readLines로) 템플릿 도움말 파일에서 읽어 writeLines).

+0

내 몸을 굴리는 것은 고통스러워하지 않습니다. 나는 그것이 이미 존재하지 않는다는 것에 놀랐다. –