Commit e0541f63 authored by davidkep's avatar davidkep

add R man page

parent 7bbfaa09
......@@ -22,4 +22,5 @@ LinkingTo:
Suggests:
testthat (>= 2.1.0)
License: MIT + file LICENSE
RoxygenNote: 6.0.1
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
#' C++ Template Library for Non-smooth Optimization
#'
#' For information how to use *nsoptim*, see the API Documentation at <https://nsoptim.readthedocs.io>.
#' The library can also be use in combination with the `inline` package by using `plugin = 'nsoptim'`.
#'
#' @name nsoptim
NULL
inlineCxxPlugin <- function(...) {
plugin <- Rcpp::Rcpp.plugin.maker(package = 'nsoptim',
plugin <- Rcpp::Rcpp.plugin.maker(package = 'nsoptim', LinkingTo = c('nsoptim', 'RcppArmadillo', 'Rcpp'),
include.before = '#include <nsoptim.hpp>')
settings <- plugin()
settings$env$PKG_CPPFLAGS <- '-I../inst/include'
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/nsoptim.R
\name{nsoptim}
\alias{nsoptim}
\title{C++ Template Library for Non-smooth Optimization}
\description{
For information how to use \emph{nsoptim}, see the API Documentation at \url{https://nsoptim.readthedocs.io}.
The library can also be use in combination with the \code{inline} package by using \code{plugin = 'nsoptim'}.
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment