1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
\name{tclVarFun}
\alias{makeTclNames}
\alias{tclFun}
\alias{tclGetValue}
\alias{tclSetValue}
\alias{tclVarExists}
\alias{tclVarFind}
\alias{tclVarName}
\title{ Manipulate R variables and functions from tcl and back }
\description{
These functions are intended to provide a better "duality" between the name of
variables in both R and tcl, including for function calls. It is possible to
define a variable with the same name in R and tcl (the content is identical,
but copied and coerced in the two respective environments). It is also possible
to get the value of a tcl variable from R, and to call a R function from within
tcl. These functionnalities are provided in the tcltk package, but Tcl variable
usually have different internal names as R equivalents.
}
\usage{
makeTclNames(names, unique = FALSE)
tclFun(f, name = deparse(substitute(f)))
tclGetValue(name)
tclSetValue(name, value)
tclVarExists(name)
tclVarFind(pattern)
tclVarName(name, init = "", keep.existing = TRUE)
}
\arguments{
\item{names}{ transform names so that they are valid for variables in Tcl. }
\item{unique}{ should these names be unique in the vector? }
\item{f}{ an R function. currently, do no support functions with arguments. }
\item{name}{ the name of a variable. }
\item{value}{ The value to place in a variable. }
\item{pattern}{ a pattern to search for. }
\item{init}{ initial value to use when creating the variable. }
\item{keep.existing}{ if the tcl variable already exist, should we keep its content? }
}
\details{
These functions are similar to \code{tclVar()} from package tcltk, except for
the following change: here, it is possible to propose a name for the created
tcl variable, or to set or retrieve the content of a tcl variable that is not
mirrored in R.
}
\value{
Most of these functions return a \code{tclVar} object.
}
\author{ Philippe Grosjean }
\seealso{ \code{\link{tk2edit}} }
\examples{
\dontrun{
## These cannot be run by examples() but should be OK when pasted
## into an interactive R session with the tcltk package loaded
## Tcl functions and variables manipulation
tclVarExists("tcl_version")
tclVarExists("probably_non_existant")
tclVarFind("tcl*")
## Using tclVarName() and tclGetValue()...
## intented for better match between R and Tcl variables
Test <- tclVarName("Test", "this is a test!")
## Now 'Test' exist both in R and in Tcl... In R, you need to use
tclvalue(Test) # to retrieve its content
## If a variable already exists in Tcl, its content is preserved using
## keep.existing = TRUE
## Create a variable in Tcl and assign "just a test..." to it
tclSetValue("A_Variable", "just to test...")
## Create the dual variable with same name
A_Variable <- tclVarName("A_Variable", "something else?")
tclvalue(A_Variable) # Content of the variable is not changed!
## If you want to retrieve the content of a Tcl variable,
## but do not want to create a reference to it in R, use:
## Create a Tcl variable, not visible from R
tclSetValue("Another_Variable", 1:5)
tclGetValue("Another_Variable") # Get its content in R (no conversion!)
tclSetValue("Another_Variable", paste("Am I", c("happy", "sad"), "?"))
tclGetValue("Another_Variable") # Get its content in R (no conversion!)
}
}
\keyword{ utilities }
\concept{ Tcl/Tk variables and proc, function callback }
|
