2016-09-23 5 views
2

네임 스페이스 용 RStudio & devtools의 도움으로 패키지를 만들었습니다. 설명 페이지 & 맨 페이지 용 Roxygen2. 이것은 정상적으로 작동했으며, 최근에 추가 한 도움말 페이지도 효과가있었습니다. 저자 이름, 이메일 및 세부 정보를 추가하기로 결정했습니다. 처음에 수동으로 다음 document()R github 패키지 w/devtools : 경고 알 수없는 매크로 ' item'

와 RM은 파일의 변경을 밀어 R 스크립트 Roxygen2 부품 &을 편집하지만 man 페이지 파일 (BAD)을 편집하여 내 패키지 내가 설치할 때 다음과 같은

devtools::install_github('SimonDedman/gbm.auto') 

내가 얻을 경고 :

Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:35: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:37: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:39: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:41: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:43: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:45: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:47: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:49: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:51: unexpected section header '\value' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:55: unexpected section header '\description' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:65: unexpected section header '\examples' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:69: unexpected END_OF_INPUT ' 
' 

그 항목은 내가 변경되지했습니다 단순한 @param 인수, 잘보고 전 일이다. Ditto value/description/examples 인수는 모두 표준이지만 (업스트림 문제가 해결되면 해결 될 수있는 다운 스트림 문제 일 수 있음).

누구든지이 문제의 원인을 생각할 수 있습니까? 비록이 문제가 하나의 스크립트 (gbm.valuemap.R)와 관련이 있다고해도 다른 도움 페이지가 있어야한다고 생각할지라도 내 도움말 페이지 중 아무 것도 클릭 할 수 없습니다.

미리 감사드립니다.

+0

'는에서만 유효합니다 항목 화 "환경".당신의 문서는 \ item이'\ itemize {\ item hi \ item bye}'또는'\ enumerate {\ item hi \ item bye''안에 만 나타나는 그런 문서입니까? '\ value','\ description'과'\ examples'도'@ value','@ description'과'@ examples'이어야합니다. 이것에 대한 더 자세한 정보는'roxygen2' 가이드를보십시오. – Chrisss

+0

RStudio를 사용하여 문제가있는 .Rd 파일을 열고 미리보기를 사용하는 방법은 무엇입니까? 이전 작업 버전이있는 경우 .Rd의 두 버전 간의 차이점을 비교할 수도 있습니다. 또 다른 야생 추측은 수동으로 일부 파일을 편집하면 인식하지 못했던 인코딩/줄 끝 변경이있을 수 있다는 것입니다. – dracodoc

+1

완전히 확실하지 않지만 "가져 오기 (예 : read.csv) 지정 (& specify)"과 같이 줄에 '&'가있을 수 있습니다. 구두점 중 일부는 문제가 있으며 특히'%'라고 생각합니다. '&'를'와'로 바꾸는 것은 가치가 있습니다. – Benjamin

답변

2

당신은 몇 가지 측면에서 패키지 개발에 도움이 RStudio를 사용할 수 있습니다

  1. 사용 패키지 프로젝트에 대한 빌드 패널에 &로드 도구를 구축 할 수 있습니다. 문서를 작성하고 업데이트 할 수 있습니다 (Roxygen2 설정에 대한 추가 옵션을 확인하고 일부는 기본적으로 켜지지 않음). 한 번 클릭으로 패키지를로드하십시오. 당신이 만난 오류는 더 일찍 발견되어야하며 수동으로 설치하여 테스트 할 필요가 없습니다.

  2. 는 .Rd에 대한 미리보기 기능이

또 다른 방법은 차이를 찾을 수있는 작업 및 비 작업 버전의 소스 파일, .Rd 파일을 비교하는 파일을 사용합니다.

일반적으로 생성 된 파일의 직접 편집은 피해야합니다.

그것은 같은 라인에서 & 수 있습니다 을 "(예)로 가져 오기를 & 지정 read.csv"

이 응답을 더 완벽하게하려면, 여기 RD 파일에 서식 지정에 대한 @Benjamin의 끝은 나는 완전히 확신하지는 않지만. 의 구두점이 특히 그렇다고 생각합니다. @Thomas 슛

을에 &을 변경하고 가치가있을 수도 있습니다 :

당신이 길 잃은이있는 경우도 올 수 {곳 item` \

+0

감사합니다. 이 문제가있는 사람은 누구나 @Thomas의 메모에 배어있는 중괄호를주의해야합니다. –