roxygen2 및 RStudio, 함수에 대한 설명서를 만들지 않음

패키지에 roxygen2를 통해 설명서를 추가하려고합니다. 나는 packag를 성공적으로 만들 수 있고, 또한 함수를 사용할 수있다. 여기에 대한 이해가있다. RStudio에서 비어있는 R-Package 프로젝트를 만든 다음 "getSomething.R"이라는 소스 파일을 만든다. 내용은roxygen2 및 RStudio, 함수에 대한 설명서를 만들지 않음

#' Test function to ask on stackoverflow 
#' 
#' \code{getSomething} Does something to get something. 
#' 
#' @param a param 1 
#' @param b param 2 
#' 
#' 

getSomething <- function(a,b){ 
    return(a*b) 
}

지금, 내가 구축하고 이상적으로/사람이 폴더에 .Rd 파일로 패키지를 만들고 또한 "? getSomething"일을 마련해야 패키지를로드, 다음과 같다. 그러나 명령을 사용하거나 Rd 파일이 생성되지 않습니다. 내가 여기서 뭔가를 놓치고 있니? 저의 원래 프로젝트에는 필자가 추가 한 종속 패키지가 있습니다.

에 이어 ENT 버튼을 누르면 DVR의 파일은, 또한

Package: testPackage 
Type: Package 
Title: Learn how to use roxygen2. 
Version: 1.0.1 
Date: 2014-11-27 
Author: amj2403 
Maintainer: amj2403 <emailid> 
Description: Write something here 
License: NA 
Depends: 
    R (>= 3.0.0), 
    rjson, 
    futile.logger, 
    RCurl

네임 스페이스 파일

exportPattern ("^ [: 알파 :] +"

I는 I 생각 몇 가지 중요한 단계가 빠져 있습니다

출처

2014-12-01 Avinash

"Roxygen을 사용하여 문서 생성"으로 RStudio 프로젝트를 구성 했습니까? – Roland

@Roland 예, 있습니다. 현재, 나는 그것을 만들기 전에 oxygenize ("패키지 이름")을 실행하고 잘 동작합니다. 그러나 나는 그것이 다르게 작동해야한다고 생각하고 있었다. – Avinash

roxygen을 사용하여 설명서를 생성하도록 구성한 경우 클릭하여 "구성"하고 "실행시 자동으로 로그 제닉스 :"필드를 설정 했습니까? –

RStudio의 기본값은 roxygen2를 활성화 할 때 t입니다. o 패키지 빌드 및 R CMD CHECK에는 모든 것을 roxygenise하지만 "빌드 및 다시로드"에는 해당하지 않습니다. 이를 가능하게하려면 프로젝트 옵션 -> 빌드 도구로 이동하십시오. 그런 다음 "Roxygen을 사용하여 문서 생성"옆의 "구성"버튼을 클릭하고 "Build & 다시로드"상자를 선택하십시오.

출처

2014-12-08 13:20:08

때때로 RStudio는 "Generate documentation with Roxygen"확인란을 전혀 표시하지 않습니다. 이 경우 R 콘솔 유형 라이브러리 (roxygen2)에 갑자기 나타납니다.

기본값을 사용하여 기본값을로드하고 사용하도록 설정하는 것이 좋을 것 같습니다.

출처

2016-05-17 18:09:18 userJT

roxygen2 및 RStudio, 함수에 대한 설명서를 만들지 않음

답변

관련 문제