roxygen 문서를 사용하여 이미지 포함

Question

roxygen으로 생성 된 문서에 이미지를 포함 할 수 있습니까? 나는 본질적으로 ggplot()에 대한 래퍼 인 많은 함수를 가지고 있는데 출력 예제를 보여줌으로써 문서화하고 싶다. R 2.14의 발표로부터의 변경 목록 당으로

Answer 1

: HTML 또는 유액로 변환 할 때 수치가 도움말 페이지에 포함 할 수 있도록

RD 마크 업이 새로운 \ 그림 태그가 있습니다. 에는 par() 및 points()에 대한 도움말 페이지의 예제가 있습니다. 에서

: http://cran.r-project.org/doc/manuals/R-exts.html#Figures

이 도움말 페이지의 수치를 포함는 \ 그림 마크 업을 사용합니다. 세 가지 형식이 있습니다.

일반적으로 사용되는 두 가지 간단한 양식은 \ figure {filename} 및 \ figure {filename} {alternate text}입니다. 여기에는 HTML 또는 LaTeX 출력에 그림의 사본이 포함됩니다. 텍스트 출력시 대체 텍스트가 대신 표시됩니다. 두 번째 인수가 생략되면 파일 이름이 사용됩니다. 파일 이름과 대체 텍스트는 모두 구문 분석되며 HTML 또는 LaTeX에서 중요한 특수 문자는 포함하지 않아야합니다.

전문가 형태는 \ figure {filename} {options : string}입니다. ('options :'라는 단어는 표시된대로 정확하게 입력해야하며 적어도 하나 이상의 공백이 있어야합니다.)이 형식에서 문자열은 src img 태그 뒤에있는 특성이나 \ img 태그의 두 번째 인수로 HTML img 태그에 복사됩니다. 기본적으로 \ includegraphics 호출에 대한 옵션으로 사용되는 LaTeX의 Figure 매크로. 단일 문자열이 두 디스플레이 모드 모두에 충분하지는 않으므로 전문가 양식은 일반적으로 조건부로 래핑됩니다. 합법적 인 HTML/LaTeX가 사용되는지 확인하는 것은 저자의 몫입니다. 수치를 포함

\if{html}{\figure{logo.jpg}{Our logo}} 
\if{latex}{\figure{logo.jpg}{options: width=0.5in}} 

파일 디렉토리 남자에 보관해야합니다 : 예를 들어, 두 HTML에서 로고 (간단한 양식을 사용)과 LaTeX의 (전문가의 양식을 사용), 다음이 사용될 수를 포함합니다/피규어. 해당 디렉토리의 .jpg, .pdf, .png 및 .svg 확장자를 가진 파일은 설치시 help/figures 디렉토리에 복사됩니다. (PDF 형식의 그림은 대부분의 HTML 브라우저에서는 표시되지 않지만 참조 설명서에서는 최상의 선택 일 수 있습니다.) \ figure 지시문에서 man/figures와 관련된 파일 이름을 지정하십시오.