roxygenize가 실패했는지 확인할 수 있습니까?

Question

roxygenize (패키지 roxygen2)을 실행할 때 문제가 있는지 감지 할 수 있습니까?

문서화, 확인 및 패키지 작성 프로세스를 자동화하고 문서화가 잘못되었을 때 중단하고 싶습니다.

roxygenize help는 반환 값이 NULL이며 성공하지 못한 채 stackoverflow를 검색한다고 말합니다. 현재, "Error"로 시작하는 줄이 있는지 출력을 찾고 검색해야합니다.

감사합니다.

Answer 1

roxygenize이 오류를 찾으면 (예 : stop("Raise an error")을 코드에 넣은 경우) roxygenize은 오류를 반환합니다.

다른 시나리오 (진행 상황)는 roxygenise이 완료 될 수 있지만 설명서 프로세스의 일부 측면이 잘못되었습니다. 이 경우 이러한 오류는 경고로 저장됩니다. 따라서 한 가지 해결책은 경고를 오류로 변경하는 것입니다.

#' @XXX 

이 원인이 : 우리가 경고를 변경 한 경우

roxygenise("pkg/") 

경고

Warning: XXX is an unknown key in block AllGenerics.R:5 

인상

예를 들어

, 당신은 라인을 포함하는 파일을 있다고 가정 오류 :

38,269,그런 다음

roxygenise("pkg/") 

는 오류가 발생합니다 :

Error: (converted from warning) XXX is an unknown key in block AllGenerics.R:5 

그런 다음 오류를 처리하기위한 표준 tryCatch 기술을 사용할 수 있습니다.