代码书写01--argparse命令行参数解析

在命令行中运行R脚本，可以使用Rscript practice.R的方式，其中practice.R是我们希望运行的脚本。在Linux和Unix系统中，有一种更简介的方式，即通过在脚本第一行添加#! /usr/bin/env Rscript的方式，来告诉操作系统这段脚本的要调用Rscript来运行。此时只要进入到practice.R所在的路径中，使用命令./practice.R便可以直接运行这段代码。类似地，如果是一段Python3脚本的话，我们可以使用#! /usr/bin/env Python3

argparse is an R package which provides a command line parser to be used with Rscript to write "#!" shebang scripts that gracefully accept positional and optional arguments and automatically generate usage.

argparse包分为三个步骤：

1. 使用ArgumentParser()创建一个参数解析对象
2. 使用add_argument()为前面的对象增加参数
3. 通过parse_args()把解析对象赋值并在后续程序中调用

我们可以先把下面的脚本储存成为example.R，这段脚本的作用是输出若干个随机数，具体的随机分布与输出参数数量由命令行参数决定。

#! /usr/bin/env Rscript
library(argparse)

# 创建参数解析对象
parser <- ArgumentParser()

# 设置参数
# 设置第一个参数verbose，缩写为v，其作用是告诉脚本是否打印完整的计算过程，其缺省值为TRUE
parser$add_argument("-v", "--verbose", action="store_true", default=TRUE,
        help="Print extra output [default]")

# 设置第二个参数quietly，缩写为q，其作用是修改verbose参数，当调用改参数时，verbose被修改为FALSE，从而导致不再打印计算过程
parser$add_argument("-q", "--quietly", action="store_false", 
        dest="verbose", help="Print little output")

# 设置第三个参数count，缩写为c，这是一个整数参数，缺省值5，在后续的代码中被用作确定输出随机数的个数
parser$add_argument("-c", "--count", type="integer", default=5, 
        help="Number of random normals to generate [default %(default)s]",
        metavar="number")

# 设置第四个参数generator，无缩写，用于确定调用何种随机分布，缺省值rnorm对应于正态分布
parser$add_argument("--generator", default="rnorm", 
        help = "Function to generate random deviates [default \"%(default)s\"]")

# 设置第五个参数mean，无缩写，浮点数，用于确定正态分布的均值，缺省值为0
parser$add_argument("--mean", default=0, type="double",
        help="Mean if generator == \"rnorm\" [default %(default)s]")

# 设置第五个参数sd，无缩写，浮点数，用于确定正态分布的标准差，缺省值为1
parser$add_argument("--sd", default=1, type="double",
        metavar="standard deviation",
        help="Standard deviation if generator == \"rnorm\" [default %(default)s]")

# 调用解析器，此时args就被赋值为命令行参数输入的相应值
args <- parser$parse_args()

# 根据verbose确定是否打印计算过程
if ( args$verbose ) { 
        write("writing some verbose output to standard error...\n", stderr()) 
}

# 根据其他参数，确定输出随机数的类型与次数
if( args$generator == "rnorm") {
        cat(paste(rnorm(args$count, mean=args$mean, sd=args$sd), collapse="\n"))
} else {
        cat(paste(do.call(args$generator, list(args$count)), collapse="\n"))
}
cat("\n")

首先修改脚本的权限，为其添加可执行权限

sudo chmod +x example.R

然后便可以使用了

• 查看帮助

./example.R --help

• 执行脚本

./practice.R

使用参数输出3个正态分布随机数

./practice.R --mean=10 --sd=10 --count=3

也可以输出均匀分布随机数，并且选择不打印计算过程

./practice.R --quiet -c 4 --generator="runif"

参考：
Data Science at the Command Line
argparse: Command line optional and positional argument parser