같은 패키지에 roxygen2와 doxygen을 사용하고 있습니까?

같은 패키지에 roxygen2와 doxygen을 사용하고 있습니까?

닫았습니다. 이 질문은의견 기반의현재 답변을 받고 있지 않습니다.

---

이 질문을 개선하시겠습니까?이 게시물을 편집하여 사실과 인용문으로 답변할 수 있도록 질문을 업데이트하십시오.

4년 전에 문을 닫았어요

이 질문을 개선하다

나는 가지고 있다.R가 사용하는 패키지roxygen2조금 있어요.C코드를 입력하다/src, 그리고 나는 이제 막 일을 시작했다.Doxygen문서를 통합하거나 roxygen2와 컴파일을 통합하는 방법이 있습니까?설치 장소의 '베스트 프랙티스'C코드 문서?

roxygen2 및 doxygen에 대한 구글링은 주로 roxygen을 유도하는 것은 doxygen 결과와 유사하다.Doxy files가 포함된 패키지를 몇 개 찾았지만 일관된 조직은 없습니다.예를들면,lme4라는 이름의 폴더에 출력이 있습니다.doxygen바깥에lme4소스 디렉토리매트릭스의 루트 디렉토리에도 Doxy 파일이 있습니다(단, 이전 릴리스에서는inst이 매뉴얼은 패키지 디렉토리 외부로도 내보냅니다.

를 포함하지 않을 이유가 있습니까?C패키지 내의 매뉴얼 또는 Doxygen이 널리 사용됨에도 불구하고 R 패키지 내에서 자주 사용되지 않는 이유C?

업데이트: 관련 Roxygen2 기능 요청 참조

저는 개인적으로 모든 스크립트에서 호출하는 "data Management" 패키지에 다음 코드를 사용합니다.이 문서에는 록시겐 문서와 예가 포함되어 있습니다.실제로는 document()를 호출하고 src/에서 doxygen을 C 코드로 실행시킵니다.문서가 inst/doxygen에 삽입되어 패키지가 CRAN 준비되었습니다.

R 최종 사용자용으로 설계된 R 매뉴얼은 C 코드를 참조하지 않도록 되어 있습니다.클래식 R 매뉴얼에는 C 코드 매뉴얼을 통합하지 않았지만, 그 결과 C 매뉴얼을 "vignette"로 복사하는 것이 좋습니다.

    library("testthat")
    library("devtools")

    #' @title Replace a value for a given tag on file in memory
    #' @description Scan the lines and change the value for the named tag if one line has this tag, 
    #'    add a line at the end if no line has this tag and return a warning if several lines
    #'    matching the tag
    #' @param fileStrings A vector with each string containing a line of the file
    #' @param tag The tag to be searched for 
    #' @param newVal The new value for the tag
    #' @return The vector of strings with the new value
    #' @examples
    #' fakeFileStrings <- c("Hello = world","SURE\t= indeed","Hello = you")
    #' 
    #' expect_warning(ReplaceTag(fakeFileStrings,"Hello","me"))
    #' 
    #' newFake <- ReplaceTag(fakeFileStrings,"SURE","me")
    #' expect_equal(length(newFake), length(fakeFileStrings))
    #' expect_equal(length(grep("SURE",newFake)), 1)
    #' expect_equal(length(grep("me",newFake)), 1)
    #' 
    #' newFake <- ReplaceTag(fakeFileStrings,"Bouh","frightened?")
    #' expect_equal(length(newFake), length(fakeFileStrings)+1)
    #' expect_equal(length(grep("Bouh",newFake)), 1)
    #' expect_equal(length(grep("frightened?",newFake)), 1)
    ReplaceTag <- function(fileStrings,tag,newVal){
        iLine <- grep(paste0("^",tag,"\\>"),fileStrings)
        nLines <- length(iLine)
        if(nLines == 0){
            line <- paste0(tag,"\t= ",newVal)
            iLine <- length(fileStrings)+1
        }else if (nLines > 0){
            line <- gsub("=.*",paste0("= ",newVal),fileStrings[iLine])
            if(nLines >1){
                warning(paste0("File has",nLines,"for key",tag,"check it up manually"))
            }
        }
        fileStrings[iLine] <- line
        return(fileStrings)
    }
    #' Prepares the R package structure for use with doxygen
    #' @description Makes a configuration file in inst/doxygen
    #'     and set a few options: 
    #'     \itemize{
    #'        \item{EXTRACT_ALL = YES}
    #'        \item{INPUT = src/}
    #'        \item{OUTPUT_DIRECTORY = inst/doxygen/}
    #'     }
    #' @param rootFolder The root of the R package
    #' @return NULL
    #' @examples 
    #' \dontrun{
    #' DoxInit()
    #' }
    #' @export
    DoxInit <- function(rootFolder="."){
        doxyFileName <- "Doxyfile"
        initFolder <- getwd()
        if(rootFolder != "."){
            setwd(rootFolder)
        }
        rootFileYes <- length(grep("DESCRIPTION",dir()))>0
        # prepare the doxygen folder
        doxDir <- "inst/doxygen"
        if(!file.exists(doxDir)){
            dir.create(doxDir,recursive=TRUE)
        }
        setwd(doxDir)

        # prepare the doxygen configuration file
        system(paste0("doxygen -g ",doxyFileName))
        doxyfile <- readLines("Doxyfile")
        doxyfile <- ReplaceTag(doxyfile,"EXTRACT_ALL","YES")
        doxyfile <- ReplaceTag(doxyfile,"INPUT","src/")
        doxyfile <- ReplaceTag(doxyfile,"OUTPUT_DIRECTORY","inst/doxygen/")
        cat(doxyfile,file=doxyFileName,sep="\n")
        setwd(initFolder)
        return(NULL)
    }

    #' devtools document function when using doxygen
    #' @description Overwrites devtools::document() to include the treatment of 
    #'    doxygen documentation in src/
    #' @param doxygen A boolean: should doxygen be ran on documents in src?
    #'     the default is TRUE if a src folder exist and FALSE if not
    #' @return The value returned by devtools::document()
    #' @example
    #' \dontrun{
    #' document()
    #' }
    #' @export
    document <- function(doxygen=file.exists("src")){
        if(doxygen){
            doxyFileName<-"inst/doxygen/Doxyfile"
            if(!file.exists(doxyFileName)){
                DoxInit()
            }
            system(paste("doxygen",doxyFileName))
        }
        devtools::document()
    }

언급URL : https://stackoverflow.com/questions/20713521/using-roxygen2-and-doxygen-on-the-same-package