Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

adding useDynLib through Roxygen

I am converting my packages to use roxygen documentation, through the roxygen2 package. Now my package does not load and I think that is is because of the missing useDynLib(mypackage) call missing from the NAMESPACE file. How do I get this generated?

like image 408
Andrew Redd Avatar asked Dec 06 '11 22:12

Andrew Redd


1 Answers

Start a package-level documentation file. In your example, R/mypackage.R that contains something like:

#' mypackage: A package for computating the notorious bar statistic.
#'
#' The mypackage package provides three categories of important functions:
#' foo, bar and baz.
#' 
#' @section Mypackage functions:
#' The mypackage functions ...
#'
#' @docType package
#' @name mypackage
#' @useDynLib mypackage
NULL
#> NULL

I also struggled for a bit to get .registration=TRUE. That is

#' @useDynLib mypackage, .registration=TRUE
like image 107
dfrankow Avatar answered Oct 21 '22 22:10

dfrankow