2

質問

複数のソースファイルから単一のソースファイルにソースコードを統合する効率的な方法は何ですか?Roxygenドキュメントのコメントを含み、場合によっては他のコメントも含みますか?

コメントを説明する(属性「フィールド」に入れる)パッケージの解析メソッドがあったことを覚えていますが、もう見つかりません。


背景情報

主に2つの理由から、特定の数のソースファイルから単一のソースファイルにソースコードを統合する柔軟性が気に入っています。

  1. 頭を上げ続けるために、私は「ファイルごとに1つの定義」パラダイムに固執しています。このパラダイムでは、各ソースファイルに正確に1つの定義(関数、S4メソッド、S4参照クラスなど)が含まれています。また、これらのソースファイルは、私の「ソースディレクトリ」のさまざまなサブディレクトリに保存されている可能性があり、したがって同じファイル名を持っている可能性もあります。ただし、真のRパッケージをまとめるには、複数のdefを1つのソースファイルにグループ化する方がよい場合があります。重複したファイル名の場合、私もそうする必要があります。
  2. 並列化する場合、必要なすべてのソースコードを1つのファイルにグループ化し、それをワーカープロセスにプッシュして、コードをソースできるようにすると便利です。

宿題

これが私の現在の解決策です。「大丈夫」と感じますが

  1. 私はそれを行うためのより良い、より効率的な方法があるかもしれないと感じています
  2. Roxygenコードの検出に関しては少し壊れやすいようです

サンプルソースファイルの作成

foo1 <- function(x) {message("I'm foo #1"); return(TRUE)}
roxy.1 <- c(
    "#' Title foo1()",
    "#'", 
    "#' Description foo1().",
    "##' This line is commented out",
    "#'", 
    "#' @param x Some R object that doesn't matter.",
    "#' @return \\code{TRUE}.",
    "#' @references \\url{http://www.something.com/}",
    "#' @author Janko Thyson \\email{john.doe@@something.com}",
    "#' @seealso \\code{\\link{foo2}}",
    "#' @example inst/examples/foo1.R"
)

foo2 <- function(y) {message("I'm foo #2"); return(FALSE)}
roxy.2 <- c(
    "#' Title foo2()",
    "#'", 
    "#' Description foo2().",
    "##' This line is commented out",
    "#'", 
    "#' @param y Some R object that doesn't matter.",
    "#' @return \\code{FALSE}.",
    "#' @references \\url{http://www.something.com/}",
    "#' @author Janko Thyson \\email{john.doe@@something.com}",
    "#' @seealso \\code{\\link{foo1}}",
    "#' @example inst/examples/foo2.R"
)

dir.create("src/functions", recursive=TRUE, showWarnings=FALSE)
dir.create("src/conso", recursive=TRUE, showWarnings=FALSE)

write(roxy.1, file="src/functions/foo1.R")
write(deparse(foo1), file="src/functions/foo1.R", append=TRUE)
write(roxy.2, file="src/functions/foo2.R")
write(deparse(foo2), file="src/functions/foo2.R", append=TRUE)

統合機能

consolidateThis <- function(
    path="src/functions",
    path.conso="src/conso/src_functions.R",
    rgx.roxy="^(#' ?|##' ?)(\\w*|@|$)",
    do.overwrite=TRUE,
    do.roxygen=TRUE,
    ...
) {
    if (!file.exists(path)) {
        stop("Check your 'path' argument")
    }
    files <- list.files(path, full.names=TRUE)
    if (do.overwrite) {
        file.create(path.conso)
    }
    sapply(files, function(ii) {
        this <- readLines(con=ii, warn=FALSE)
        code <- base::parse(text=this)
        if (do.roxygen) {     
            idx.roxy <- grep(rgx.roxy, this)
            if (length(idx.roxy)) {
                if (length(idx.roxy) == 1) {
                    stop("Weird roxygen code (just a one-liner)") 
                }
                bench <- seq(from=idx.roxy[1], max(idx.roxy))
                if (!all(bench %in% idx.roxy)) {
                    stop("Breaks in your roxygen code. Possibly detected comments that aren't roxygen code")
                }
                code.roxy <- this[idx.roxy]
                write(code.roxy, file=path.conso, append=TRUE)
            }
        }
        write(c(deparse(code[[1]]), ""), file=path.conso, append=TRUE)
    })
    return(path.conso)
}

関数を適用する

path <- consolidateThis()
> path
[1] "src/conso/src_functions.R"

これで、統合されたコードを含むソースファイル「src / conso/src_functions.R」ができました。

4

1 に答える 1

2

関数のソースを解析する(そして解凍する)必要が特にありますか?そうでない場合は、コードをかなり単純化できます。

以下は、とまったく同じ出力を生成しConsolidateThis()ます。

ConsolidateThis2 <-
function(path="src/functions",
         path.conso="src/conso/src_functions.R",
         overwrite = TRUE) {
    if(overwrite) cat("", file = path.conso) # Blank out the file's contents

    ## A function to append infile's contents to outfile and add 2 <RET>          
    prettyappend <- function(infile, outfile) {
        file.append(outfile, infile)
        cat("\n\n", file = outfile, append = TRUE)
    }

    ## Append all files in 'path.conso' to file 'path'
    sapply(dir(path, full.names=TRUE), prettyappend, path.conso)
}

ConsolidateThis2()
于 2012-09-12T16:14:44.140 に答える