Complete {svMisc}R Documentation

Get a completion list for a R code fragment

Description

A list with matching items is returned in a string.

Usage

Complete(code, givetype = FALSE, sep = "\t")

Arguments

code A fraction of R code needing completion
givetype Do we append the type of each entry to the list? Not supported in this version
sep The separator to use between returned items

Details

The completion list is context-dependent, and it is calculated as if the code was entered at the command line.

If the code ends with $, then the function look for items in a list or data.frame whose name is the last idfentifier.

If the code ends with @, then the function look for slots of the corresponding S4 object.

If the code ends with ::, then it looks for objects in a namespace.

If the code ends with a partial identifier name, the function returns all visible matching keywords.

There are other situations where the completion can be calculated, see the help of rc.settings().

Value

A string with the completion list (items separated by 'sep'), or an unique string completing unambiguously the current code, starting with 'sep'

Note

This function uses utils:::.win32consoleCompletion() as completion engine, then, it makes the result compatible with old version of Complete().

Author(s)

Philippe Grosjean <phgrosjean@sciviews.org>

See Also

CallTip, rc.settings()

Examples

    ## a data.frame
    data(iris)
        Complete("item <- iris$")
        Complete("item <- iris[[", TRUE)
        
        ## An S4 object
    setClass("track", representation(x = "numeric", y = "numeric"))
    t1 <- new("track", x=1:20, y=(1:20)^2)
    Complete("item2 <- t1@", TRUE)
    
    ## A namespace
        Complete("utils::")
        
        ## A partial identifier
    Complete("item3 <- va", TRUE)
    
    ## Otherwise, a list with the content of .GlobalEnv
    Complete("item4 <- ")

[Package svMisc version 0.9-46 Index]