The rcl Reference Manual

2.1.1 rcl/rcl.asd

Source

rcl.asd.

Parent Component

rcl (system).

ASDF Systems

rcl.

---

2.1.2 rcl/defpackage.lisp

Source

rcl.asd.

Parent Component

rcl (system).

Packages

• rcl.
• rcl.ffi.

---

2.1.3 rcl/config.lisp

Dependency

defpackage.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• *r-home* (special variable).
• *r-lib* (special variable).
• *r-lib-extension* (special variable).
• *r-lib-name* (special variable).
• *r-lib-path* (special variable).

---

2.1.4 rcl/init.lisp

Dependency

config.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

• ensure-r (function).
• r-init (function).
• r-quit (function).

Internals

• %var-accessor-*r-cstacklimit* (function).
• (setf %var-accessor-*r-cstacklimit*) (function).
• %var-accessor-*r-interactive* (function).
• (setf %var-accessor-*r-interactive*) (function).
• %var-accessor-*r-signalhandlers* (function).
• (setf %var-accessor-*r-signalhandlers*) (function).
• *r-cstacklimit* (symbol macro).
• *r-interactive* (symbol macro).
• *r-lib-loaded* (special variable).
• *r-session* (special variable).
• *r-signalhandlers* (symbol macro).
• disable-signal-handling (function).
• disable-stack-checking (function).
• ensure-non-interactive (function).
• getenv (function).
• set-r-home (function).
• setenv (function).
• version (function).

---

2.1.5 rcl/math.lisp

Dependency

init.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• exp-rand (function).
• expm1 (function).
• norm-rand (function).
• r-pow (function).
• r-pow-di (function).
• rf-bessel-i (function).
• rf-bessel-j (function).
• rf-bessel-k (function).
• rf-bessel-y (function).
• rf-beta (function).
• rf-choose (function).
• rf-dbeta (function).
• rf-dbinom (function).
• rf-dcauchy (function).
• rf-dchisq (function).
• rf-dexp (function).
• rf-df (function).
• rf-dgamma (function).
• rf-dgeom (function).
• rf-dhyper (function).
• rf-digamma (function).
• rf-dlnorm (function).
• rf-dlogis (function).
• rf-dnbeta (function).
• rf-dnbinom (function).
• rf-dnchisq (function).
• rf-dnf (function).
• rf-dnorm4 (function).
• rf-dnt (function).
• rf-dpois (function).
• rf-dsignrank (function).
• rf-dt (function).
• rf-dunif (function).
• rf-dweibull (function).
• rf-dwilcox (function).
• rf-fmax2 (function).
• rf-fmin2 (function).
• rf-fprec (function).
• rf-fround (function).
• rf-fsign (function).
• rf-ftrunc (function).
• rf-gammafn (function).
• rf-imax2 (function).
• rf-imin2 (function).
• rf-lbeta (function).
• rf-lchoose (function).
• rf-lgamma1p (function).
• rf-lgammafn (function).
• rf-log1pmx (function).
• rf-logspace-add (function).
• rf-logspace-sub (function).
• rf-pbeta (function).
• rf-pbinom (function).
• rf-pcauchy (function).
• rf-pchisq (function).
• rf-pentagamma (function).
• rf-pexp (function).
• rf-pf (function).
• rf-pgamma (function).
• rf-pgeom (function).
• rf-phyper (function).
• rf-plnorm (function).
• rf-plogis (function).
• rf-pnbeta (function).
• rf-pnbinom (function).
• rf-pnchisq (function).
• rf-pnf (function).
• rf-pnorm-both (function).
• rf-pnorm5 (function).
• rf-pnt (function).
• rf-ppois (function).
• rf-psigamma (function).
• rf-psignrank (function).
• rf-pt (function).
• rf-ptukey (function).
• rf-punif (function).
• rf-pweibull (function).
• rf-pwilcox (function).
• rf-qbeta (function).
• rf-qbinom (function).
• rf-qcauchy (function).
• rf-qchisq (function).
• rf-qexp (function).
• rf-qf (function).
• rf-qgamma (function).
• rf-qgeom (function).
• rf-qhyper (function).
• rf-qlnorm (function).
• rf-qlogis (function).
• rf-qnbinom (function).
• rf-qnchisq (function).
• rf-qnf (function).
• rf-qnorm5 (function).
• rf-qnt (function).
• rf-qpois (function).
• rf-qsignrank (function).
• rf-qt (function).
• rf-qtukey (function).
• rf-qunif (function).
• rf-qweibull (function).
• rf-qwilcox (function).
• rf-rbeta (function).
• rf-rbinom (function).
• rf-rcauchy (function).
• rf-rchisq (function).
• rf-rexp (function).
• rf-rf (function).
• rf-rgamma (function).
• rf-rgeom (function).
• rf-rhyper (function).
• rf-rlnorm (function).
• rf-rlogis (function).
• rf-rnbinom (function).
• rf-rnchisq (function).
• rf-rnorm (function).
• rf-rpois (function).
• rf-rsignrank (function).
• rf-rt (function).
• rf-runif (function).
• rf-rweibull (function).
• rf-rwilcox (function).
• rf-sign (function).
• rf-tetragamma (function).
• rf-trigamma (function).
• unif-rand (function).

---

2.1.6 rcl/funtab.lisp

Dependency

init.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• %var-accessor-*r-funtab* (function).
• (setf %var-accessor-*r-funtab*) (function).
• *r-funtab* (symbol macro).
• funtab-tclass (class).
• get-builtin-name (function).
• ppinfo-tclass (class).

---

2.1.7 rcl/alien-helper.lisp

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• *r-lock* (special variable).
• defcfun (macro).
• in-r-thread (macro).
• with-float-traps-masked (macro).

---

2.1.8 rcl/alien-defs.lisp

Dependencies

• init.lisp (file).
• alien-helper.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• %r-checkactivity (function).
• %r-gc (function).
• %r-getcurrentenv (function).
• %r-parseevalstring (function).
• %r-runhandlers (function).
• %r-tryeval (function).
• %r-tryevalsilent (function).
• %rf-allocvector (function).
• %rf-aschar (function).
• %rf-ascharacterfactor (function).
• %rf-asinteger (function).
• %rf-aslogical (function).
• %rf-aslogical2 (function).
• %rf-asreal (function).
• %rf-coercevector (function).
• %rf-conformable (function).
• %rf-elt (function).
• %rf-eval (function).
• %rf-findfun (function).
• %rf-findvar (function).
• %rf-inherits (function).
• %rf-install (function).
• %rf-isarray (function).
• %rf-iscomplex (function).
• %rf-isenvironment (function).
• %rf-isexpression (function).
• %rf-isfactor (function).
• %rf-isframe (function).
• %rf-isfunction (function).
• %rf-isinteger (function).
• %rf-islanguage (function).
• %rf-islist (function).
• %rf-islogical (function).
• %rf-ismatrix (function).
• %rf-isnewlist (function).
• %rf-isnull (function).
• %rf-isnumber (function).
• %rf-isnumeric (function).
• %rf-isobject (function).
• %rf-isordered (function).
• %rf-ispairlist (function).
• %rf-isprimitive (function).
• %rf-isreal (function).
• %rf-isstring (function).
• %rf-issymbol (function).
• %rf-ists (function).
• %rf-isunordered (function).
• %rf-isunsorted (function).
• %rf-isuserbinop (function).
• %rf-isvalidstring (function).
• %rf-isvalidstringf (function).
• %rf-isvector (function).
• %rf-isvectoratomic (function).
• %rf-isvectorizable (function).
• %rf-isvectorlist (function).
• %rf-length (function).
• %rf-mkchar (function).
• %rf-mkcharlen (function).
• %rf-mkstring (function).
• %rf-ncols (function).
• %rf-nrows (function).
• %rf-pairtovectorlist (function).
• %rf-printvalue (function).
• %rf-printversionstring (function).
• %rf-protect (function).
• %rf-unprotect (function).
• %rf-unprotect-ptr (function).
• %rf-vectortopairlist (function).
• %var-accessor-*r-baseenv* (function).
• (setf %var-accessor-*r-baseenv*) (function).
• %var-accessor-*r-basenamespace* (function).
• (setf %var-accessor-*r-basenamespace*) (function).
• %var-accessor-*r-curerrorbuf* (function).
• (setf %var-accessor-*r-curerrorbuf*) (function).
• %var-accessor-*r-currentexpression* (function).
• (setf %var-accessor-*r-currentexpression*) (function).
• %var-accessor-*r-dimsymbol* (function).
• (setf %var-accessor-*r-dimsymbol*) (function).
• %var-accessor-*r-emptyenv* (function).
• (setf %var-accessor-*r-emptyenv*) (function).
• %var-accessor-*r-globalenv* (function).
• (setf %var-accessor-*r-globalenv*) (function).
• %var-accessor-*r-inbcinterpreter* (function).
• (setf %var-accessor-*r-inbcinterpreter*) (function).
• %var-accessor-*r-inputhandlers* (function).
• (setf %var-accessor-*r-inputhandlers*) (function).
• %var-accessor-*r-missingarg* (function).
• (setf %var-accessor-*r-missingarg*) (function).
• %var-accessor-*r-naint* (function).
• (setf %var-accessor-*r-naint*) (function).
• %var-accessor-*r-namespaceregistry* (function).
• (setf %var-accessor-*r-namespaceregistry*) (function).
• %var-accessor-*r-namessymbol* (function).
• (setf %var-accessor-*r-namessymbol*) (function).
• %var-accessor-*r-nan* (function).
• (setf %var-accessor-*r-nan*) (function).
• %var-accessor-*r-nareal* (function).
• (setf %var-accessor-*r-nareal*) (function).
• %var-accessor-*r-nastring* (function).
• (setf %var-accessor-*r-nastring*) (function).
• %var-accessor-*r-neginf* (function).
• (setf %var-accessor-*r-neginf*) (function).
• %var-accessor-*r-nilvalue* (function).
• (setf %var-accessor-*r-nilvalue*) (function).
• %var-accessor-*r-posinf* (function).
• (setf %var-accessor-*r-posinf*) (function).
• %var-accessor-*r-restarttoken* (function).
• (setf %var-accessor-*r-restarttoken*) (function).
• %var-accessor-*r-srcref* (function).
• (setf %var-accessor-*r-srcref*) (function).
• %var-accessor-*r-unboundvalue* (function).
• (setf %var-accessor-*r-unboundvalue*) (function).
• *r-baseenv* (symbol macro).
• *r-basenamespace* (symbol macro).
• *r-curerrorbuf* (symbol macro).
• *r-currentexpression* (symbol macro).
• *r-dimsymbol* (symbol macro).
• *r-emptyenv* (symbol macro).
• *r-globalenv* (symbol macro).
• *r-inbcinterpreter* (symbol macro).
• *r-inputhandlers* (symbol macro).
• *r-missingarg* (symbol macro).
• *r-naint* (symbol macro).
• *r-namespaceregistry* (symbol macro).
• *r-namessymbol* (symbol macro).
• *r-nan* (symbol macro).
• *r-nareal* (symbol macro).
• *r-nastring* (symbol macro).
• *r-neginf* (symbol macro).
• *r-nilvalue* (symbol macro).
• *r-posinf* (symbol macro).
• *r-restarttoken* (symbol macro).
• *r-srcref* (symbol macro).
• *r-unboundvalue* (symbol macro).
• closxp_struct-tclass (class).
• envsxp_struct-tclass (class).
• listsxp_struct-tclass (class).
• primsxp_struct-tclass (class).
• promsxp_struct-tclass (class).
• r-checkactivity (function).
• r-gc (function).
• r-getcurrentenv (function).
• r-parseevalstring (function).
• r-runhandlers (function).
• r-tryeval (function).
• r-tryevalsilent (function).
• rcomplex-tclass (class).
• rf-allocvector (function).
• rf-aschar (function).
• rf-ascharacterfactor (function).
• rf-asinteger (function).
• rf-aslogical (function).
• rf-aslogical2 (function).
• rf-asreal (function).
• rf-coercevector (function).
• rf-conformable (function).
• rf-elt (function).
• rf-eval (function).
• rf-findfun (function).
• rf-findvar (function).
• rf-inherits (function).
• rf-install (function).
• rf-isarray (function).
• rf-iscomplex (function).
• rf-isenvironment (function).
• rf-isexpression (function).
• rf-isfactor (function).
• rf-isframe (function).
• rf-isfunction (function).
• rf-isinteger (function).
• rf-islanguage (function).
• rf-islist (function).
• rf-islogical (function).
• rf-ismatrix (function).
• rf-isnewlist (function).
• rf-isnull (function).
• rf-isnumber (function).
• rf-isnumeric (function).
• rf-isobject (function).
• rf-isordered (function).
• rf-ispairlist (function).
• rf-isprimitive (function).
• rf-isreal (function).
• rf-isstring (function).
• rf-issymbol (function).
• rf-ists (function).
• rf-isunordered (function).
• rf-isunsorted (function).
• rf-isuserbinop (function).
• rf-isvalidstring (function).
• rf-isvalidstringf (function).
• rf-isvector (function).
• rf-isvectoratomic (function).
• rf-isvectorizable (function).
• rf-isvectorlist (function).
• rf-length (function).
• rf-mkchar (function).
• rf-mkcharlen (function).
• rf-mkstring (function).
• rf-ncols (function).
• rf-nrows (function).
• rf-pairtovectorlist (function).
• rf-printvalue (function).
• rf-printversionstring (function).
• rf-protect (function).
• rf-unprotect (function).
• rf-unprotect-ptr (function).
• rf-vectortopairlist (function).
• sexprec-tclass (class).
• sxpinfo_struct-tclass (class).
• symsxp_struct-tclass (class).
• vecsxp_struct-tclass (class).
• vector_sexprec-tclass (class).

---

2.1.9 rcl/alien-R.lisp

Dependency

alien-defs.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• %r-flushconsole (function).
• %r-processevents (function).
• r-flushconsole (function).
• r-processevents (function).

---

2.1.10 rcl/alien-Rembedded.lisp

Dependency

alien-defs.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• %cleaned (function).
• %fpu-setup (function).
• %r-cleantempdir (function).
• %r-repldlldo1 (function).
• %r-repldllinit (function).
• %r-saveglobalenv (function).
• %r-setstarttime (function).
• %rf-endembeddedr (function).
• %rf-initembeddedr (function).
• %rf-initialize-r (function).
• %rf-killalldevices (function).
• %rf-runexitfinalizers (function).
• %setup-rmainloop (function).
• %var-accessor-*r-dirtyimage* (function).
• (setf %var-accessor-*r-dirtyimage*) (function).
• %var-accessor-*r-tempdir* (function).
• (setf %var-accessor-*r-tempdir*) (function).
• *r-dirtyimage* (symbol macro).
• *r-tempdir* (symbol macro).
• cleaned (function).
• fpu-setup (function).
• r-cleantempdir (function).
• r-repldlldo1 (function).
• r-repldllinit (function).
• r-saveglobalenv (function).
• r-setstarttime (function).
• rf-endembeddedr (function).
• rf-initembeddedr (function).
• rf-initialize-r (function).
• rf-killalldevices (function).
• rf-runexitfinalizers (function).
• setup-rmainloop (function).

---

2.1.11 rcl/alien-altrep.lisp

Dependency

alien-defs.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• %altinteger-elt (function).
• %altinteger-max (function).
• %altinteger-min (function).
• %altinteger-set-elt (function).
• %altinteger-sum (function).
• %altlogical-elt (function).
• %altlogical-set-elt (function).
• %altlogical-sum (function).
• %altraw-elt (function).
• %altraw-set-elt (function).
• %altreal-elt (function).
• %altreal-max (function).
• %altreal-min (function).
• %altreal-set-elt (function).
• %altreal-sum (function).
• %altrep-length (function).
• %altrep-truelength (function).
• %altstring-elt (function).
• %altstring-set-elt (function).
• %integer-get-region (function).
• %integer-is-sorted (function).
• %integer-no-na (function).
• %logical-get-region (function).
• %logical-is-sorted (function).
• %logical-no-na (function).
• %r-compact-intrange (function).
• %r-deferred-coercetostring (function).
• %r-tryunwrap (function).
• %r-trywrap (function).
• %raw-get-region (function).
• %real-get-region (function).
• %real-is-sorted (function).
• %real-no-na (function).
• %string-is-sorted (function).
• %string-no-na (function).
• altinteger-elt (function).
• altinteger-max (function).
• altinteger-min (function).
• altinteger-set-elt (function).
• altinteger-sum (function).
• altlogical-elt (function).
• altlogical-set-elt (function).
• altlogical-sum (function).
• altraw-elt (function).
• altraw-set-elt (function).
• altreal-elt (function).
• altreal-max (function).
• altreal-min (function).
• altreal-set-elt (function).
• altreal-sum (function).
• altrep-length (function).
• altrep-truelength (function).
• altstring-elt (function).
• altstring-set-elt (function).
• integer-get-region (function).
• integer-is-sorted (function).
• integer-no-na (function).
• logical-get-region (function).
• logical-is-sorted (function).
• logical-no-na (function).
• r-compact-intrange (function).
• r-deferred-coercetostring (function).
• r-tryunwrap (function).
• r-trywrap (function).
• raw-get-region (function).
• real-get-region (function).
• real-is-sorted (function).
• real-no-na (function).
• string-is-sorted (function).
• string-no-na (function).

---

2.1.12 rcl/events.lisp

Dependency

alien-defs.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

• *use-quartz* (special variable).
• x11 (function).

Internals

• *event-loop* (special variable).
• event-loop (function).
• process-events (function).

---

2.1.13 rcl/types.lisp

Dependency

alien-defs.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• *r-types* (special variable).
• *r-vector-types* (special variable).
• anysxp (special variable).
• bcodesxp (special variable).
• builtinsxp (special variable).
• charsxp (special variable).
• closxp (special variable).
• cplxsxp (special variable).
• dotsxp (special variable).
• envsxp (special variable).
• exprsxp (special variable).
• extptrsxp (special variable).
• freesxp (special variable).
• funsxp (special variable).
• intsxp (special variable).
• langsxp (special variable).
• lglsxp (special variable).
• listsxp (special variable).
• newsxp (special variable).
• nilsxp (special variable).
• promsxp (special variable).
• rawsxp (special variable).
• realsxp (special variable).
• s4sxp (special variable).
• specialsxp (special variable).
• strsxp (special variable).
• symsxp (special variable).
• vecsxp (special variable).
• weakrefsxp (special variable).

---

2.1.14 rcl/alien-macros.lisp

Dependency

types.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

• new-string (macro).
• new-string-single (macro).

Internals

• envsxp-enclos (macro).
• envsxp-frame (macro).
• envsxp-hashtab (macro).
• listsxp-car (macro).
• listsxp-cdr (macro).
• listsxp-tag (macro).
• new-character (macro).
• new-complex (macro).
• new-integer (macro).
• new-internal-char (macro).
• new-language-construct (macro).
• new-list (macro).
• new-logical (macro).
• new-real (macro).
• primsxp-offset (macro).
• promsxp-env (macro).
• promsxp-expr (macro).
• promsxp-value (macro).
• sexp-attrib (macro).
• sexp-next-node (macro).
• sexp-prev-node (macro).
• sexp-sxpinfo (macro).
• sexp-union (macro).
• sexp-vecsxp (macro).
• sxpinfo-bitfield (macro).
• symsxp-internal (macro).
• symsxp-pname (macro).
• symsxp-value (macro).
• vecsxp-length (macro).
• vecsxp-truelength (macro).

---

2.1.15 rcl/vectors.lisp

Dependency

alien-macros.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• get-data-bytes (function).
• get-data-integers (function).
• get-data-reals (function).
• get-data-sexps (function).
• get-data-strings (function).
• set-data-bytes (function).
• set-data-integers (function).
• set-data-reals (function).
• set-data-sexps (function).
• set-data-strings (function).

---

2.1.16 rcl/symbol.lisp

Dependency

alien-macros.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

print-object (method).

Internals

• internal (reader method).
• (setf internal) (writer method).
• name (reader method).
• (setf name) (writer method).
• r-symbol (class).
• value (reader method).
• (setf value) (writer method).

---

2.1.17 rcl/promise.lisp

Dependency

alien-macros.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

print-object (method).

Internals

• environment (reader method).
• (setf environment) (writer method).
• expression (reader method).
• (setf expression) (writer method).
• r-promise (class).
• value (reader method).
• (setf value) (writer method).

---

2.1.18 rcl/language.lisp

Dependency

alien-macros.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

print-object (method).

Internals

• environment (reader method).
• (setf environment) (writer method).
• expression (reader method).
• (setf expression) (writer method).
• r-language (class).
• value (reader method).
• (setf value) (writer method).

---

2.1.19 rcl/environment.lisp

Dependency

alien-macros.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

print-object (method).

Internals

• frame (method).
• hashtab (method).
• name (reader method).
• (setf name) (writer method).
• parent (method).
• path (reader method).
• (setf path) (writer method).
• r-environment (class).

---

2.1.20 rcl/matrix.lisp

Dependency

defpackage.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

• print-object (method).
• r-matrix (class).

Internals

• matrix (reader method).
• (setf matrix) (writer method).
• names (reader method).
• (setf names) (writer method).

---

2.1.21 rcl/debug.lisp

Dependency

alien-macros.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• debug-info (function).
• debug-sexprec (function).

---

2.1.22 rcl/attributes.lisp

Dependency

symbol.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

*debug-attributes* (special variable).

Internals

• *r-attributes-prefix* (special variable).
• attributes-list (function).
• decode-attributes (function).
• print-attributes (function).

---

2.1.23 rcl/dataframe.lisp

Dependency

defpackage.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

print-object (method).

Internals

• data (reader method).
• (setf data) (writer method).
• names (reader method).
• (setf names) (writer method).
• r-dataframe (class).
• rownames (reader method).
• (setf rownames) (writer method).

---

2.1.24 rcl/r-pointer.lisp

Dependency

defpackage.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

• print-object (method).
• r-to-lisp (generic function).

Internals

• *unprotect-runner* (special variable).
• make-r-pointer (function).
• pointer (reader method).
• (setf pointer) (writer method).
• r-header (generic function).
• r-obj-describe (generic function).
• r-obj-p (function).
• r-pointer (class).
• r-type (generic function).
• schedule-unprotect-task (function).
• sexp-alt-p (generic function).
• sexp-nil-p (generic function).
• sexp-unbound-p (generic function).
• start-unprotect-runner (function).

---

2.1.25 rcl/decode.lisp

Dependencies

• vectors.lisp (file).
• attributes.lisp (file).
• types.lisp (file).
• r-pointer.lisp (file).
• dataframe.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

r-to-lisp (method).

Internals

• decode-builtin (function).
• decode-closure (function).
• decode-environment (function).
• decode-language-construct (function).
• decode-promise (function).
• group-elements (function).
• r-header (method).
• r-obj-describe (method).
• r-type (method).
• sexp-alt-p (method).
• sexp-nil-p (method).
• sexp-unbound-p (method).
• sxpinfo-decode (function).

---

2.1.26 rcl/encode.lisp

Dependencies

• vectors.lisp (file).
• r-pointer.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

lisp-to-r (function).

---

2.1.27 rcl/funcall.lisp

Dependencies

• encode.lisp (file).
• decode.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

*downcase-argnames* (special variable).

Internals

• *r-funcall-debug* (special variable).
• r%-symbol (function).
• r%-variable (function).
• r-funcall (function).
• r-function (function).
• r-symbol (function).
• r-variable (function).

---

2.1.28 rcl/streams.lisp

Dependency

funcall.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

*r-streams* (special variable).

Internals

• *r-message* (special variable).
• *r-message-prefix* (special variable).
• *r-output* (special variable).
• *r-output-prefix* (special variable).
• with-r-message (macro).
• with-r-output (macro).
• with-r-streams (macro).

---

2.1.29 rcl/reader.lisp

Dependency

funcall.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Internals

• *return-pointer* (special variable).
• r-reader (function).
• rcl-list-reader (function).
• rcl-reader-error (condition).
• read-and-parse-rcl-token (function).
• read-rcl-token (function).
• signal-reader-error (macro).
• whitespacep (function).

---

2.1.30 rcl/high-level.lisp

Dependency

streams.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

• r (function).
• r% (function).
• r%-parse-eval (function).
• r-parse-eval (function).
• r-print (function).
• r-summary (function).

Internals

• r%-ignore (function).
• r%-values (function).
• r-ignore (function).
• r-values (function).

---

2.1.31 rcl/devices.lisp

Dependency

high-level.lisp (file).

Source

rcl.asd.

Parent Component

rcl (system).

Public Interface

• with-device (macro).
• with-par (macro).
• with-pdf (macro).

Internals

device-details (function).

---

4.1.1 Special variables

Special Variable: *debug-attributes* ¶

Print to standard output details about attributes when encountered

Package

rcl.

Source

attributes.lisp.

Special Variable: *downcase-argnames* ¶

By default, if an argument name is all uppercase it will be converted to downcase. This makes (r "sum" x :na.rm t) equivalent to (r "sum" x :|na.rm| t).
Disable the automatic conversion if you need to pass all-uppercase argument names to R.

Package

rcl.

Source

funcall.lisp.

Special Variable: *r-streams* ¶

What to do when calling with-r-stream: :console (don’t capture), :print, or :string

Package

rcl.

Source

streams.lisp.

Special Variable: *use-quartz* ¶

On MacOSX open Quartz windows by default when possible, instead of using X11

Package

rcl.

Source

events.lisp.

---

4.1.2 Macros

Macro: new-string (n) ¶

Package

rcl.

Source

alien-macros.lisp.

Macro: new-string-single (string) ¶

Package

rcl.

Source

alien-macros.lisp.

Macro: with-device ((filename type &rest options) &body body) ¶

Executes the body after opening a graphical device that is closed at the end; options are passed to R (known types: :ps, :pdf, :png, :jp[e]g, :xfig, :pictex)

Package

rcl.

Source

devices.lisp.

Macro: with-par ((&rest args) &body body) ¶

Sets graphical parameters, giving a list of the form :key1 val1 :key2 val2
The number of rows and columns can be pased directly as the first and second arguments, but if those are the only args they will be ignored if already set (i.e. mfrow is not (1 1)).

Package

rcl.

Source

devices.lisp.

Macro: with-pdf ((filename paper) &body body) ¶

Package

rcl.

Source

devices.lisp.

---

4.1.3 Ordinary functions

Function: ensure-r (&rest libraries) ¶

Starts an R session if required and loads all the specified packages.

Package

rcl.

Source

init.lisp.

Function: lisp-to-r (x) ¶

Package

rcl.

Source

encode.lisp.

Function: r (&rest args) ¶

Call r% and decode the result

Package

rcl.

Source

high-level.lisp.

Function: r% (&rest args) ¶

Apply the first argument to rest of the arguments (returns an r-pointer).
If there is single string argument that looks like a formula (contains ~), calls r%-parse-eval instead.

Package

rcl.

Source

high-level.lisp.

Function: r%-parse-eval (string) ¶

Parse and evaluate the string in the R environment (returns r-pointer)

Package

rcl.

Source

high-level.lisp.

Function: r-init () ¶

Package

rcl.

Source

init.lisp.

Function: r-parse-eval (string) ¶

Call r%-parse-eval and decode the result

Package

rcl.

Source

high-level.lisp.

Function: r-print (x &optional to-string) ¶

Calls R function print on the object (and returns nil).

Package

rcl.

Source

high-level.lisp.

Function: r-quit () ¶

Package

rcl.

Source

init.lisp.

Function: r-summary (x &optional to-string) ¶

Prints the R summary of the object (and returns nil).

Package

rcl.

Source

high-level.lisp.

Function: x11 (&optional quartz) ¶

Package

rcl.

Source

events.lisp.

---

4.1.4 Generic functions

Generic Function: r-to-lisp (sexp) ¶

Package

rcl.

Source

r-pointer.lisp.

Methods

Method: r-to-lisp (sexp) ¶

Source

decode.lisp.

Method: r-to-lisp ((sexp r-pointer)) ¶

---

4.1.5 Standalone methods

Method: print-object ((matrix r-matrix) stream) ¶

Source

matrix.lisp.

Method: print-object ((r-symbol r-symbol) stream) ¶

Source

symbol.lisp.

Method: print-object ((r-pointer r-pointer) stream) ¶

Source

r-pointer.lisp.

Method: print-object ((env r-environment) stream) ¶

Source

environment.lisp.

Method: print-object ((r-language r-language) stream) ¶

Source

language.lisp.

Method: print-object ((r-promise r-promise) stream) ¶

Source

promise.lisp.

Method: print-object ((dataframe r-dataframe) stream) ¶

Source

dataframe.lisp.

---

4.1.6 Classes

Class: r-matrix ¶

Package

rcl.

Source

matrix.lisp.

Direct methods

• (setf matrix).
• matrix.
• (setf names).
• names.
• print-object.

Direct slots

Slot: matrix ¶

Initargs

:matrix

Readers

matrix.

Writers

(setf matrix).

Slot: names ¶

Initargs

:names

Readers

names.

Writers

(setf names).

---

4.2.1 Special variables

Special Variable: *event-loop* ¶

Package

rcl.

Source

events.lisp.

Special Variable: *r-attributes-prefix* ¶

Default prefix used to print attributes

Package

rcl.

Source

attributes.lisp.

Special Variable: *r-funcall-debug* ¶

Package

rcl.

Source

funcall.lisp.

Special Variable: *r-home* ¶

Package

rcl.

Source

config.lisp.

Special Variable: *r-lib* ¶

Package

rcl.

Source

config.lisp.

Special Variable: *r-lib-extension* ¶

Package

rcl.

Source

config.lisp.

Special Variable: *r-lib-loaded* ¶

Package

rcl.

Source

init.lisp.

Special Variable: *r-lib-name* ¶

Package

rcl.

Source

config.lisp.

Special Variable: *r-lib-path* ¶

Package

rcl.

Source

config.lisp.

Special Variable: *r-lock* ¶

Package

rcl.

Source

alien-helper.lisp.

Special Variable: *r-message* ¶

Default stream where R messages will be sent if captured

Package

rcl.

Source

streams.lisp.

Special Variable: *r-message-prefix* ¶

Default prefix used to print lines of R messages

Package

rcl.

Source

streams.lisp.

Special Variable: *r-output* ¶

Default stream where R output will be sent if captured

Package

rcl.

Source

streams.lisp.

Special Variable: *r-output-prefix* ¶

Default prefix used to print lines of R output

Package

rcl.

Source

streams.lisp.

Special Variable: *r-session* ¶

Package

rcl.

Source

init.lisp.

Special Variable: *r-types* ¶

Package

rcl.

Source

types.lisp.

Special Variable: *r-vector-types* ¶

Package

rcl.

Source

types.lisp.

Special Variable: *return-pointer* ¶

Package

rcl.

Source

reader.lisp.

Special Variable: *unprotect-runner* ¶

Package

rcl.

Source

r-pointer.lisp.

Special Variable: anysxp ¶

make "any" args work. Used in specifying types for symbol registration to mean anything is okay

Package

rcl.

Source

types.lisp.

Special Variable: bcodesxp ¶

byte code

Package

rcl.

Source

types.lisp.

Special Variable: builtinsxp ¶

builtin non-special forms

Package

rcl.

Source

types.lisp.

Special Variable: charsxp ¶

"scalar" string type (internal only)

Package

rcl.

Source

types.lisp.

Special Variable: closxp ¶

closures

Package

rcl.

Source

types.lisp.

Special Variable: cplxsxp ¶

complex variables

Package

rcl.

Source

types.lisp.

Special Variable: dotsxp ¶

dot-dot-dot object

Package

rcl.

Source

types.lisp.

Special Variable: envsxp ¶

environments

Package

rcl.

Source

types.lisp.

Special Variable: exprsxp ¶

expressions vectors

Package

rcl.

Source

types.lisp.

Special Variable: extptrsxp ¶

external pointer

Package

rcl.

Source

types.lisp.

Special Variable: freesxp ¶

node released by GC

Package

rcl.

Source

types.lisp.

Special Variable: funsxp ¶

Closure or Builtin

Package

rcl.

Source

types.lisp.

Special Variable: intsxp ¶

integer vectors

Package

rcl.

Source

types.lisp.

Special Variable: langsxp ¶

language constructs (special lists)

Package

rcl.

Source

types.lisp.

Special Variable: lglsxp ¶

logical vectors

Package

rcl.

Source

types.lisp.

Special Variable: listsxp ¶

lists of dotted pairs

Package

rcl.

Source

types.lisp.

Special Variable: newsxp ¶

fresh node created in new page

Package

rcl.

Source

types.lisp.

Special Variable: nilsxp ¶

nil = NULL

Package

rcl.

Source

types.lisp.

Special Variable: promsxp ¶

promises: [un]evaluated closure arguments

Package

rcl.

Source

types.lisp.

Special Variable: rawsxp ¶

raw bytes

Package

rcl.

Source

types.lisp.

Special Variable: realsxp ¶

real variables

Package

rcl.

Source

types.lisp.

Special Variable: s4sxp ¶

S4 classes not of simple type

Package

rcl.

Source

types.lisp.

Special Variable: specialsxp ¶

special forms

Package

rcl.

Source

types.lisp.

Special Variable: strsxp ¶

string vectors

Package

rcl.

Source

types.lisp.

Special Variable: symsxp ¶

symbols

Package

rcl.

Source

types.lisp.

Special Variable: vecsxp ¶

generic vectors

Package

rcl.

Source

types.lisp.

Special Variable: weakrefsxp ¶

weak reference

Package

rcl.

Source

types.lisp.

---

4.2.2 Symbol macros

Symbol Macro: *r-baseenv* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-basenamespace* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-cstacklimit* ¶

Package

rcl.

Source

init.lisp.

Symbol Macro: *r-curerrorbuf* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-currentexpression* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-dimsymbol* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-dirtyimage* ¶

Package

rcl.ffi.

Source

alien-rembedded.lisp.

Symbol Macro: *r-emptyenv* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-funtab* ¶

Package

rcl.

Source

funtab.lisp.

Symbol Macro: *r-globalenv* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-inbcinterpreter* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-inputhandlers* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-interactive* ¶

Package

rcl.

Source

init.lisp.

Symbol Macro: *r-missingarg* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-naint* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-namespaceregistry* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-namessymbol* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-nan* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-nareal* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-nastring* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-neginf* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-nilvalue* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-posinf* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-restarttoken* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-signalhandlers* ¶

Package

rcl.

Source

init.lisp.

Symbol Macro: *r-srcref* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

Symbol Macro: *r-tempdir* ¶

Package

rcl.ffi.

Source

alien-rembedded.lisp.

Symbol Macro: *r-unboundvalue* ¶

Package

rcl.ffi.

Source

alien-defs.lisp.

---