R-package 설명서 (.Rd) 파일에 이미지 포함

광산 패키지에 시각화 기능을 문서화하기 위해 노력하고 있습니다. 이 목적을 위해 나는 Rd 파일 'funcname.Rd'를 통해 임베디드 된 이미지를 갖고 싶습니다.이 파일은 함수에서 사용되는 다양한 매개 변수를 설명 할 수 있으며, 사용자가 패키지 수동 PDF를 읽거나 '? funcname '의 라인 R. 뭔가에 :R-package 설명서 (.Rd) 파일에 이미지 포함

Manual example

'작성 R의 extensions'-문서는이 문제를 해결하지 않는 것, 내가 찾을 수있는 유일한 참조 this blog post 및 this R-devel discussion했다. 전자는 'base64'라는 패키지에 대한 링크가 끊어져 있으며 후자는 R 패키지 비 네트의 이미지를 포함하는 등 다양한 대안을 제시합니다. 이것이 CRAN과 호환 될 수 있다면 좋을 것입니다.

이 문제에 접근하는 방법에 대한 조언은 감사하겠습니다.

출처

2015-01-28 Teemu Daniel Laajala

Rd 파일을 일반 텍스트로 처리 할 수 있어야합니다. 예제에서 그러한 숫자를 생성하는 코드를 포함하는 것을 선호합니다. – Roland

이것은 R-devel 토론에서 제안한 해결 방법 중 하나입니다. 분명히 'example (funcname)'을 사용하는 것은 사람들이 사용한 것입니다. R에서 제작 한 수치는 여러 매개 변수가 무엇인지 지적하기 위해 그림에서 여러 개의 양식화 된 줄, 중괄호 등을 사용하기를 원했고 R에서이 작업을 수행하는 것이 다소 불편할 수 있습니다. 그러나 당신은 정확합니다. –

일부 사용자 (많은 사용자)는 해당 그림을 볼 수 없다는 점에 유의하십시오. 예 : 명령 줄에서 작업하는 경우 – Roland

안된하지만, GitHub의에 R 소스에서 보면, 그들이 다음과 같은 방식으로 ?par documentation file에 이미지를 추가 나타납니다 :

\item{\code{mai}}{A numerical vector of the form \code{c(bottom, 
     left, top, right)} which gives the margin size specified in 
     inches.\cr 
     \if{html}{\figure{mai.png}{options: width="35\%" alt="Figure: mai.png"}} 
     \if{latex}{\figure{mai.pdf}{options: width=7cm}} 
    }

그림은 /man/figures에 저장 것으로 보인다.

출처

2015-01-28 10:16:35

고마워! 나는 그것을 조사 할 것이다. –

이것은 현재 가장 좋은 방법 인 것으로 보입니다. 내 목적을 위해 그것은 잘 작동하지만 롤랜드는 위의 그의 의견에서 지적한 것처럼 모든 사용자가 그 숫자를 보길 기대하지 않아야한다. –

미래에이 질문을하는 사람을위한 FYI. 위에서 지정한 구문이 잘 작동합니다! – schifferl

R-package 설명서 (.Rd) 파일에 이미지 포함

답변

관련 문제