为什么base :: detach验证名称输入方式呢?

时间:2013-07-09 17:31:44

标签: r

在通过Detach several packages at once工作之后,我现在想知道base::detach中的以下验证码是否存在,或者是否存在错误?

(函数本身为detach(name, pos = 2L, unload = FALSE, character.only = FALSE, force = FALSE)

if (!missing(name)) {
        if (!character.only) 
            name <- substitute(name)
        pos <- if (is.numeric(name)) 
            name
        else {
            if (!is.character(name)) 
                name <- deparse(name)
            match(name, search())
        }
        if (is.na(pos)) 
            stop("invalid 'name' argument")

在我看来,无论是否设置了“character.only”参数,最好在冒is.character(name)值运行substitute()之前测试name 。当character.only=TRUE是一个字符串时,文档没有明确说明你必须设置name 那么,在我离开并提交错误/增强请求之前,是否有充分的理由让验证成为现实?

编辑:评论mnel的回复,这是我的测试示例。

Rgames> detlist<-c('Hmisc','survival','splines')
Rgames> library(Hmisc)
 Rgames> debug(base::detach)
Rgames> base::detach(detlist[1])

# skipped the startup stuff.

Browse[2]> 
debug: if (!character.only) name <- substitute(name)
Browse[2]> name
[1] "Hmisc"
Browse[2]> 
debug: name <- substitute(name)
Browse[2]> 
debug: pos <- if (is.numeric(name)) name else {
    if (!is.character(name)) 
        name <- deparse(name)
    match(name, search())
}
Browse[2]> name
detlist[1]
Browse[2]> 
debug: if (!is.character(name)) name <- deparse(name)
Browse[2]> 
debug: name <- deparse(name)
Browse[2]> deparse(name)
[1] "detlist[1]"

所以你看到了问题。我的输入变量是有效名称,但未将character.only设置为TRUE会导致意外的deparse发生,match(name, search())因显而易见原因而失败。
在我看来,如果首先检查is.character,用户会更容易,尽管在tryCatch内处理mnel描述的情况。有两个原因:1)如果detach甚至不需要character.only参数,它更“用户友好”,2)目前的文档没有警告用户必须设置character.only==TRUEname参数是包含字符串的对象时(但不是,我相信如果它只是一个普通的字符串。请分离(包:Hmisc)或分离(“package:Hmisc “)工作,但正如我的示例所示,不是对同一字符串的引用。)

1 个答案:

答案 0 :(得分:1)

除非你知道它只是字符,否则不会冒险评估name参数。

请注意,help('detach')name参数描述为

  

这可以是不带引号的名称或字符串,但不是字符向量。如果提供了一个数字,则将其视为pos。

is.character将评估其论点,而替代则不会。如果name不是字符串,则它将是不带引号的字符串(例如package:stats)。如果您要测试is.character(x = package:stats),则会尝试评估package:stats(即调用`:`(package,stats)。这不会很好(并且会返回错误或无意义的内容,具体取决于是否您的搜索路径上有packagestats的值。)

使用character.only表示将调用substitute(不会评估参数),但会返回language类型的对象(如果原始名称是未加引号的名称) )或字符串(如果它最初是一个字符串)。无论结果如何,name都可以deparsed来创建所需的字符串。

您可以通过调用browser

来创建一个函数来跟踪发生的事情

例如

d <- function (name, pos = 2L, unload = FALSE, character.only = FALSE, 
          force = FALSE) {

  if (!missing(name)) {
    browser()
    if (!character.only) 
      name <- substitute(name)
    pos <- if (is.numeric(name)) 
      name
    else {
      if (!is.character(name)) 
        name <- deparse(name)
      match(name, search())
    }
    if (is.na(pos)) 
      stop("invalid 'name' argument")

}
  return(list(name, pos))
}

# called using an unquoted string.

d(package:stats, pos = 2L)
# Called from: d(package:stats, pos = 2L)
# Browse[1]> n
# debug at #7: if (!character.only) name <- substitute(name)
# Browse[2]> str(name)
# Error in str(name) : object 'package' not found
# Browse[2]> n
# debug at #7: name <- substitute(name)
# Browse[2]> n
# debug at #9: pos <- if (is.numeric(name)) name else {
# if (!is.character(name)) 
#   name <- deparse(name)
# match(name, search())
# }
# Browse[2]> str(name)
# language package:stats
# Browse[2]> n
# debug at #12: if (!is.character(name)) name <- deparse(name)
# Browse[2]> n
# debug at #12: name <- deparse(name)
# Browse[2]> n
# debug at #14: match(name, search())
# Browse[2]> n
# debug at #16: if (is.na(pos)) stop("invalid 'name' argument")
# Browse[2]> n
# debug at #16: NULL
# Browse[2]> str(name)
# chr "package:stats
# Browse[2]> Q

d('package:stats', pos = 2L)
# Called from: d("package:stats", pos = 2L)
# Browse[1]> n
# debug at #7: if (!character.only) name <- substitute(name)
# Browse[2]> n
# debug at #7: name <- substitute(name)
# Browse[2]> n
# debug at #9: pos <- if (is.numeric(name)) name else {
# if (!is.character(name)) 
#   name <- deparse(name)
# match(name, search())
# }
# Browse[2]> str(name)
# chr "package:stats"
# Browse[2]> Q

根据编辑过的问题进行编辑。

也许帮助文件中描述name的方式应与'package in require & library (which have similar methods of dealing with name and字符的定义一致.string`样式参数

  

包名称,以名称或文字字符串形式给出,或者   字符串,取决于character.only是否为FALSE   (默认)或TRUE)。

help('detach')中的当前定义使用character string暗示一个文字字符串,其中包含您希望detachcharacter vector定义的搜索路径上的项目名称一个字符向量,其中包含一个字符串,该字符串是您希望detach在搜索路径上的项目名称。

我将help('detach')中的定义更改为

  

这可以是不带引号的名称或文字字符串。如果character.only == TRUE则可以提供长度为1的字符向量。   如果提供了一个数字,则将其视为pos。

或类似可能会有帮助。