Data

Tools

Indexes

Applications

Experiments

Open Source Science

callme

Easily compile inline C code for R

https://github.com/coolbutuseless/callme

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary

Keywords

c r r-package
Last synced: 9 months ago · JSON representation

Repository

Easily compile inline C code for R

Basic Info
Statistics
  • Stars: 23
  • Watchers: 4
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Topics
c r r-package
Created almost 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.md

callme

CRAN status R-CMD-check <!-- badges: end -->

{callme} compiles inline C code and generates wrappers so that the C code can be easily called from R.

Features:

  • Compile inline C code (or code from a file) and makes it immediately (and easily!) available to R.
  • Accepts complete C code - including function declaration and header #include directives.
  • Explicit handling for CFLAGS, PKG_CPPFLAGS and PKG_LIBS for setting compiler flags, C pre-processor flags, and library linking flags, respectively.
  • Generates R functions to call the compiled C functions.
  • Multiple function definitions allowed in a single code block.

What’s in the box

  • compile(code, CFLAGS, PKG_CPPFLAGS, PKG_LIBS, env, verbosity) compile the C code and assign R functions into the nominated env in R. C code could be as a string or in a file.

Installation

This package can be installed from CRAN

r install.packages('callme')

You can install the latest development version from GitHub with:

``` r

install.package('remotes')

remotes::install_github('coolbutuseless/callme') ```

Pre-built source/binary versions can also be installed from R-universe

r install.packages('callme', repos = c('https://coolbutuseless.r-universe.dev', 'https://cloud.r-project.org'))

Example

The following example compiles a code snippet into a C library and creates a wrapper function in R (of the same name) which can be used to call the compiled code.

``` r library(callme)

code <- "

include

include

// Add 2 numbers SEXP add(SEXP val1, SEXP val2) { return ScalarReal(asReal(val1) + asReal(val2)); }

// Multiply 2 numbers SEXP mul(SEXP val1, SEXP val2) { return ScalarReal(asReal(val1) * asReal(val2)); }

// sqrt elements in a vector SEXP newsqrt(SEXP vec) { SEXP res = PROTECT(allocVector(REALSXP, length(vec))); double *resptr = REAL(res); double *vecptr = REAL(vec); for (int i = 0; i < length(vec); i++) { resptr[i] = sqrt(vec_ptr[i]); }

UNPROTECT(1); return res; } "

compile the code

compile(code)

Call the functions

add(99.5, 0.5) ```

#> [1] 100

r mul(99.5, 0.5) 

#> [1] 49.75

r new_sqrt(c(1, 4, 25, 999)) 

#> [1]  1.00000  2.00000  5.00000 31.60696

Linking against an installed library

In this example we want to get the version of the zstd library (which has already been installed on the computer), and return it as a character string.

We need to tell R when compiling the code:

  • to look in the /opt/homebrew/include directory for zstd.h.
  • to look for the actual zstd library in /opt/homebrew/lib.
  • to link to the zstd library (-lzstd)

Note: This code works for zstd installed via homebrew on macOS. Paths will be different for other operating systems.

``` r code <- r"(

include

include

include "zstd.h"

SEXP zstdversion() { return mkString(ZSTDversionString()); } )"

Compile the code

compile(code, PKGCPPFLAGS = "-I/opt/homebrew/include", PKGLIBS = "-L/opt/homebrew/lib -lzstd")

Call the function

zstd_version() ```

#> [1] "1.5.6"

References

R project official documentation

Owner

  • Name: mikefc
  • Login: coolbutuseless
  • Kind: user
  • Location: Australia

Cool, but useless.

GitHub Events

Total
  • Issues event: 2
  • Watch event: 6
  • Push event: 2
Last Year
  • Issues event: 2
  • Watch event: 6
  • Push event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 7
  • Total pull requests: 0
  • Average time to close issues: 14 days
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 0.57
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 3 months
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • coolbutuseless (6)
  • Beliavsky (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 198 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: callme

Easily Compile and Call Inline 'C' Functions

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 198 Last month
Rankings
Dependent packages count: 28.5%
Dependent repos count: 35.1%
Average: 50.1%
Downloads: 86.7%
Maintainers (1)
mikefc@coolbutuseless.com
Last synced: 10 months ago