2015-01-28 3 views
12

this question에서와 같이 함수 문서에 기사 인용을 포함시키고 싶습니다. 모든 설명서에 roxygen2을 사용하고 있으며 ~ roxygen2이 필요한 기능을 가지고있는 것으로 보입니다. 그러나 Hadley는 roxygen2이 유지 관리 모드 였기 때문에이 기능을 해제했습니다. 그 이후로 상황이 바뀌 었습니까? BibTeX 형식으로 저장된 기사 참조를 인용하거나 인용하는 다른 방법이 있습니까?roxygen2를 사용하여 기사 인용하기

+0

패키지의 inst 폴더 아래에 "CITATION"파일을 넣으시겠습니까? 예 : https://github.com/cran/GMD/blob/master/inst/CITATION –

+0

@xb 아니요, 외부 기사를 인용하지 말고 패키지 인용문입니다. – tchakravarty

+0

그런 다음 위와 같은 유형의 비 네트를 사용하는 경우 .bib 파일을 .Rnw에 포함 시키십시오. 예를 들어,'\ bibliographystyle {plain} \ bibliography {vignette.bib}' –

답변

2

Rdpack package은 요청한 기능을 제공 할 것을 약속합니다.

이 설정하려면, 당신은 또한 패키지의 DESCRIPTION 파일의 라인 RdMacros: Rdpack을 (자본 M주의) 추가하고, Imports: 필드에 Rdpack를 추가해야합니다.

은 그럼 당신은 inst/REFERENCES.bib에 당신하여 BibTex 라이브러리를 저장하고 사용하여 문서를 인용 할 수 있습니다 첫 번째 패키지를 사용하는 경우

#' @references{ 
#' \insertRef{bibtexKey}{YourPackageName} 
#' } 
#' 
#' # The below line ought to be included in at least one of your documentation 
#' # sections, so that roxygen2 adds Rdpack to your NAMESPACE file. 
#' 
#' @importFrom Rdpack reprompt 

내가 처음에 약간의 오차가 발생; R을 다시 시작하는 것이 트릭을하는 것처럼 보였다.

devtools::document()으로 설명서를 작성하는 경우 devtools에서 설명 파일의 'RdMacros'행을 읽지 않으므로 약 unknown macro '\insertRef'에 대한 경고가 발생합니다. 그들은 무시 될 수 있습니다. 참조는 devtools에 의해 올바르게 렌더링되지 않을 수도 있지만 패키지가 최종적으로 빌드 될 때 참조됩니다. 그 (것)들을 적당한 형식으로 임시적으로 전망하기 위하여는 R CMD Rd2pdf를 분리되는 명령 창에서 달릴 수있다.

관련 문제