Args: Describe Function Arguments

In gdata: Various R Programming Tools for Data Manipulation

Description

Display function argument names and corresponding default values, formatted in two columns for easy reading.

Usage

Args(name, sort=FALSE)

Arguments

name	a function or function name.
sort	whether arguments should be sorted.

Value

A data frame with named rows and a single column called value, containing the default value of each argument.

Note

Primitive functions like sum and all have no formal arguments. See the formals help page.

Author(s)

Arni Magnusson

See Also

Args is a verbose alternative to args, based on formals.

help also describes function arguments.

Examples

Args(glm)
Args(scan)
Args(legend, sort=TRUE)

Example output

sh: 1: cannot create /dev/null: Permission denied
gdata: Unable to locate valid perl interpreter
gdata: 
gdata: read.xls() will be unable to read Excel XLS and XLSX files
gdata: unless the 'perl=' argument is used to specify the location of a
gdata: valid perl intrpreter.
gdata: 
gdata: (To avoid display of this message in the future, please ensure
gdata: perl is installed and available on the executable search path.)
sh: 1: cannot create /dev/null: Permission denied
gdata: Unable to load perl libaries needed by read.xls()
gdata: to support 'XLX' (Excel 97-2004) files.

gdata: Unable to load perl libaries needed by read.xls()
gdata: to support 'XLSX' (Excel 2007+) files.

gdata: Run the function 'installXLSXsupport()'
gdata: to automatically download and install the perl
gdata: libaries needed to support Excel XLS and XLSX formats.

Attaching package: 'gdata'

The following object is masked from 'package:stats':

    nobs

The following object is masked from 'package:utils':

    object.size

The following object is masked from 'package:base':

    startsWith

          value    
formula            
family    gaussian 
data               
weights            
subset             
na.action          
start     NULL     
etastart           
mustart            
offset             
control   list(...)
model     TRUE     
method    "glm.fit"
x         FALSE    
y         TRUE     
contrasts NULL     
...                
                 value                                    
file             ""                                       
what             double()                                 
nmax             -1                                       
n                -1                                       
sep              ""                                       
quote            if (identical(sep, "\\n")) "" else "'\\""
dec              "."                                      
skip             0                                        
nlines           0                                        
na.strings       "NA"                                     
flush            FALSE                                    
fill             FALSE                                    
strip.white      FALSE                                    
quiet            FALSE                                    
blank.lines.skip TRUE                                     
multi.line       TRUE                                     
comment.char     ""                                       
allowEscapes     FALSE                                    
fileEncoding     ""                                       
encoding         "unknown"                                
text                                                      
skipNul          FALSE                                    
           value              
adj        c(0, 0.5)          
angle      45                 
bg         par("bg")          
border     "black"            
box.col    par("fg")          
box.lty    par("lty")         
box.lwd    par("lwd")         
bty        "o"                
cex        1                  
col        par("col")         
density    NULL               
fill       NULL               
horiz      FALSE              
inset      0                  
legend                        
lty                           
lwd                           
merge      do.lines && has.pch
ncol       1                  
pch                           
plot       TRUE               
pt.bg      NA                 
pt.cex     cex                
pt.lwd     lwd                
seg.len    2                  
text.col   par("col")         
text.font  NULL               
text.width NULL               
title      NULL               
title.adj  0.5                
title.col  text.col           
trace      FALSE              
x                             
x.intersp  1                  
xjust      0                  
xpd                           
y          NULL               
y.intersp  1                  
yjust      1                  

gdata documentation built on May 2, 2019, 5:49 p.m.