Skip to content

Commit

Permalink
Added linking info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
djvanderlaan committed Jan 25, 2017
1 parent 5cc3172 commit 4f03af2
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -249,3 +249,27 @@ y <- lload("tmp.RDS")
print(y)
```


Linking to lvec from another R package
---------------------------------------

The lvec package contains only the basic functionality for working with lvec
objects. The goal is that other packages can extend the functionality of the
lvec package. Although most extensions can probably be built directly in R code
using the functionality provided in lvec, sometimes it will be necessary to work
directly with the C++ objects behing the lvec object. To support this most
headers and some C++ functions are exported. Other packages can use these by
having

```
LinkingTo:
lvec
```
in their `DESCRIPTION` file. This makes the header files available for use by
the package. They can the include all headers using:
```
#include <lvec_interface.h>
```
in their C++ code.


0 comments on commit 4f03af2

Please sign in to comment.