web-dev-qa-db-ja.com

Rスクリプトからコマンドラインパラメータを読み取るにはどうすればよいですか?

私は(コード自体の中にハードコードパラメータの値ではなく)いくつかのコマンドラインパラメータを供給できるようにしたいRスクリプトを持っています。スクリプトはWindows上で実行されます。

コマンドラインで指定されたパラメータを自分のRスクリプトに読み込む方法に関する情報が見つかりません。それができないのであれば、私は驚かれるでしょう。だから私のグーグル検索で最高のキーワードを使っていないのかもしれません…。

任意のポインタや推奨事項?

272
monch1962

ここでDirkの答え あなたが必要とするすべてです。これは最小限の再現可能な例です。

exmpl.batexmpl.Rという2つのファイルを作りました。

  • exmpl.bat

    set R_Script="C:\Program Files\R-3.0.2\bin\RScript.exe"
    %R_Script% exmpl.R 2010-01-28 example 100 > exmpl.batch 2>&1
    

    あるいは、Rterm.exeを使用します。

    set R_TERM="C:\Program Files\R-3.0.2\bin\i386\Rterm.exe"
    %R_TERM% --no-restore --no-save --args 2010-01-28 example 100 < exmpl.R > exmpl.batch 2>&1
    
  • exmpl.R

    options(echo=TRUE) # if you want see commands in output file
    args <- commandArgs(trailingOnly = TRUE)
    print(args)
    # trailingOnly=TRUE means that only your arguments are returned, check:
    # print(commandArgs(trailingOnly=FALSE))
    
    start_date <- as.Date(args[1])
    name <- args[2]
    n <- as.integer(args[3])
    rm(args)
    
    # Some computations:
    x <- rnorm(n)
    png(paste(name,".png",sep=""))
    plot(start_date+(1L:n), x)
    dev.off()
    
    summary(x)
    

両方のファイルを同じディレクトリに保存してexmpl.batを起動します。結果は次のようになります。

  • いくつかのプロットでexample.png
  • exmpl.batchとこれまでのすべてのこと

環境変数%R_Script%を追加することもできます。

"C:\Program Files\R-3.0.2\bin\RScript.exe"

そしてあなたのバッチスクリプトで%R_Script% <filename.r> <arguments>としてそれを使用します

RScriptRtermの違いは次のとおりです。

  • Rscriptの構文が単純化されました
  • Rscriptはx64上で自動的にアーキテクチャを選択します(詳細は Rインストールと管理、2.6サブアーキテクチャ を参照してください)
  • コマンドを出力ファイルに書き込む場合は、Rscriptの.Rファイルにoptions(echo=TRUE)が必要です。
205
Marek

いくつかのポイント:

  1. コマンドラインパラメータはcommandArgs()からアクセスできます。そのため、概要についてはhelp(commandArgs)を参照してください。

  2. Windowsを含むすべてのプラットフォームでRscript.exeを使用できます。 commandArgs()をサポートします。 littler はWindowsに移植することができましたが、今はOS XとLinuxでしか生きていません。

  3. CRANには、 getoptoptparse の2つのアドオンパッケージがあり、どちらもコマンドライン解析用に書かれています。

2015年11月に編集:新しい選択肢が登場しました。私心をこめてお勧め - docopt

123

これをスクリプトの先頭に追加します。

args<-commandArgs(TRUE)

それからargs[1]args[2]などとして渡された引数を参照できます。

それから走りなさい

Rscript myscript.R arg1 arg2 arg3

引数がスペースを含む文字列の場合は、二重引用符で囲みます。

89
Hrishi Mittal

ライブラリ(getopt)を試してみてください。例えば:

spec <- matrix(c(
        'in'     , 'i', 1, "character", "file from fastq-stats -x (required)",
        'gc'     , 'g', 1, "character", "input gc content file (optional)",
        'out'    , 'o', 1, "character", "output filename (optional)",
        'help'   , 'h', 0, "logical",   "this help"
),ncol=5,byrow=T)

opt = getopt(spec);

if (!is.null(opt$help) || is.null(opt$in)) {
    cat(paste(getopt(spec, usage=T),"\n"));
    q();
}
15
Erik Aronesty

optparseは回答で数回言及されており、コマンドライン処理のための包括的なキットを提供しているので、入力ファイルが存在すると仮定した場合の使い方の簡単な例を次に示します。

script.R:

library(optparse)

option_list <- list(
  make_option(c("-n", "--count_lines"), action="store_true", default=FALSE,
    help="Count the line numbers [default]"),
  make_option(c("-f", "--factor"), type="integer", default=3,
    help="Multiply output by this number [default %default]")
)

parser <- OptionParser(usage="%prog [options] file", option_list=option_list)

args <- parse_args(parser, positional_arguments = 1)
opt <- args$options
file <- args$args

if(opt$count_lines) {
  print(paste(length(readLines(file)) * opt$factor))
}

23行の任意のファイルblah.txtがあるとします。

コマンドラインで:

Rscript script.R -h出力

Usage: script.R [options] file


Options:
        -n, --count_lines
                Count the line numbers [default]

        -f FACTOR, --factor=FACTOR
                Multiply output by this number [default 3]

        -h, --help
                Show this help message and exit

Rscript script.R -n blah.txt出力[1] "69"

Rscript script.R -n -f 5 blah.txt出力[1] "115"

11
Megatron

必要なもの littler ( 'little r'と発音)

Dirkは約15分で詳しく説明します。

10
JD Long

Bashでは、次のようにコマンドラインを作成できます。

$ z=10
$ echo $z
10
$ Rscript -e "args<-commandArgs(TRUE);x=args[1]:args[2];x;mean(x);sd(x)" 1 $z
 [1]  1  2  3  4  5  6  7  8  9 10
[1] 5.5
[1] 3.027650
$

変数$zがbash Shellで "10"に置き換えられ、この値がcommandArgsによって取得され、args[2]に渡され、rangeコマンドx=1:10がRによって正常に実行されたことなどがわかります。

6
TTW

参考:argsという名前の引数のベクトルと混同しないように、Rの関数の引数を取得する関数args()があります。

4
Tim

私はちょうどこの切り替え動作を生成するためにNiceデータ構造と一連の処理をまとめました。ライブラリは必要ありません。私はそれが何度も何度も実行されてきたと確信していて、そして例を探してこのスレッドに出くわした - 私がチップに入れると思った。

特にフラグは必要ありません(ここでの唯一のフラグはデバッグモードで、ダウンストリーム関数if (!exists(debug.mode)) {...} else {print(variables)})を開始する条件としてチェックする変数を作成します。以下のフラグチェックlapplyステートメントは次のようになります。

if ("--debug" %in% args) debug.mode <- T
if ("-h" %in% args || "--help" %in% args) 

ここでargsは、コマンドライン引数から読み込まれた変数です(たとえば、これらを指定した場合はc('--debug','--help')に相当します)。

それは他のどのフラグにも再利用可能であり、あなたはすべての繰り返しを避け、そしてライブラリはありませんので依存性はありません:

args <- commandArgs(TRUE)

flag.details <- list(
"debug" = list(
  def = "Print variables rather than executing function XYZ...",
  flag = "--debug",
  output = "debug.mode <- T"),
"help" = list(
  def = "Display flag definitions",
  flag = c("-h","--help"),
  output = "cat(help.Prompt)") )

flag.conditions <- lapply(flag.details, function(x) {
  paste0(paste0('"',x$flag,'"'), sep = " %in% args", collapse = " || ")
})
flag.truth.table <- unlist(lapply(flag.conditions, function(x) {
  if (eval(parse(text = x))) {
    return(T)
  } else return(F)
}))

help.prompts <- lapply(names(flag.truth.table), function(x){
# joins 2-space-separatated flags with a tab-space to the flag description
  paste0(c(paste0(flag.details[x][[1]][['flag']], collapse="  "),
  flag.details[x][[1]][['def']]), collapse="\t")
} )

help.Prompt <- paste(c(unlist(help.prompts),''),collapse="\n\n")

# The following lines handle the flags, running the corresponding 'output' entry in flag.details for any supplied
flag.output <- unlist(lapply(names(flag.truth.table), function(x){
  if (flag.truth.table[x]) return(flag.details[x][[1]][['output']])
}))
eval(parse(text = flag.output))

flag.detailsでは、コマンドは文字列として格納され、eval(parse(text = '...'))で評価されます。 Optparseはどんな重大なスクリプトにとっても明らかに望ましいものですが、最低限の機能を備えたコードでも良い場合があります。

出力例:

$Rscript  check_mail.Rscript  --help 
  -  debug関数XYZを実行せずに変数を表示します。 。
 
  -  h --helpフラグ定義を表示する
0
Louis Maddox

フラグ付きのオプションを指定する必要がある場合(-h、 - help、 - number = 42など)、Rパッケージoptparse(Pythonからヒントを得たもの)を使用できます。 http://cran.r -project.org/web/packages/optparse/vignettes/optparse.pdf

Bash getopt、Perl Getopt、またはpython argparseとoptparseに相当するものを探すときにこの記事を見つけたので、少なくともこの方法で私はあなたの質問を理解しています。

0
TheBinturonGggh