In ramiromagno/c3po: From C to R and back again

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

| Badge | Description | |------------------|------------------------------------------------| | r knitr::include_graphics("../man/figures/variable.svg") | Global variable. | | r knitr::include_graphics("../man/figures/struct.svg") | C struct declaration. | | r knitr::include_graphics("../man/figures/enum.svg") | C enum declaration. | | r knitr::include_graphics("../man/figures/mobj.svg") | C preprocessor object-like macro. | | r knitr::include_graphics("../man/figures/mfn.svg") | C preprocessor function-like macro. | | r knitr::include_graphics("../man/figures/typedef-dtype.svg") | Typedef predefined data type. | | r knitr::include_graphics("../man/figures/typedef-str.svg") | Typedef struct. | | r knitr::include_graphics("../man/figures/typedef-strp.svg") | Typedef struct pointer. | | r knitr::include_graphics("../man/figures/typedef-pointer.svg") | Typedef pointer. | | r knitr::include_graphics("../man/figures/typedef-array.svg") | Typedef array. | | r knitr::include_graphics("../man/figures/typedef-enum.svg") | Typedef enum. | | r knitr::include_graphics("../man/figures/typedef-fnp.svg") | Typedef function pointer. | | r knitr::include_graphics("../man/figures/fnp.svg") | Pure function, i.e., one that is run for its return value. | | r knitr::include_graphics("../man/figures/fni.svg") | Impure function, i.e., one that is run for its side effects. | | r knitr::include_graphics("../man/figures/c2r.svg") | Function that converts a C data typed object to a SEXP object. | | r knitr::include_graphics("../man/figures/r2c.svg") | Function that converts a SEXP object to a C data typed object. | | r knitr::include_graphics("../man/figures/prot.svg") | Those functions that return R objects allocated from the heap will, eventually, be freed by the garbage collector. Because this is an automatic process, it is left to the developer to signal that those returned objects should be protected from the garbage collector. The way to do this is by wrapping those objects in PROTECT(). Functions that return such objects needing protection are indicated with this badge. | | r knitr::include_graphics("../man/figures/USE_RINTERNALS.svg") | Some declarations might not be immediately accessible if the macro USE_RINTERNALS is not defined. Define USE_RINTERNALS before including header file Rinternals.h. Those C entities that require it are identified with this badge. |