source_file: Source a file containing C code

In DavisVaughan/cbuild: Tools to Make Developing R Packages Interfacing with 'C' Easier

Description

source_file() will parse through file looking for functions tagged with // [[ export() ]] and will compile the file and export those functions to the R side.

Usage

source_file(file, includes = NULL, no_remap = TRUE, show = FALSE)

Arguments

file	[character(1)] The C file to source.
includes	[NULL / character()] Extra includes to add manually. By default, R.h and Rinternals.h are included. Specify more includes with their file name. For example, to include #include <Rdefines.h> you just need to specify "Rdefines.h".
no_remap	[logical(1)] Should #define R_NO_REMAP be defined?
show	[logical(1)] Should the output of compiling the source code with R CMD SHLIB be shown?

Value

A named list containing the functions specified for export.

Examples

tf <- tempfile(fileext = ".c")

code <- "
  // [[ export() ]]
  SEXP fn(SEXP x) {
    return x;
  }
"

writeLines(code, tf)

sourced <- source_file(tf)

sourced$fn(1)

DavisVaughan/cbuild documentation built on Dec. 25, 2019, 5:11 a.m.