yonicd/sinew

RcppExports.R

daniel258 opened this issue · 3 comments

daniel258 commented

When running batch mode in R directory (e.g., makeOxyFile("/R")) it also adds documentation to files like RcppExports.R

For example 
# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param beta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname Calcb
#' @export 
Calcb <- function(beta, tm, event, ps) {
    .Call('_ICcalib_Calcb', PACKAGE = 'ICcalib', beta, tm, event, ps)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param theta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param Z PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CalcbZ
#' @export 
CalcbZ <- function(theta, tm, event, ps, Z) {
    .Call('_ICcalib_CalcbZ', PACKAGE = 'ICcalib', theta, tm, event, ps, Z)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param theta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param Z PARAM_DESCRIPTION
#' @param psDeriv PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CalcNablabeetaUbeta
#' @export 
CalcNablabeetaUbeta <- function(theta, tm, event, ps, Z, psDeriv) {
    .Call('_ICcalib_CalcNablabeetaUbeta', PACKAGE = 'ICcalib', theta, tm, event, ps, Z, psDeriv)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param theta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param Z PARAM_DESCRIPTION
#' @param psDeriv PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CalcNablabeetaUgamma
#' @export 
CalcNablabeetaUgamma <- function(theta, tm, event, ps, Z, psDeriv) {
    .Call('_ICcalib_CalcNablabeetaUgamma', PACKAGE = 'ICcalib', theta, tm, event, ps, Z, psDeriv)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param probs PARAM_DESCRIPTION
#' @param points PARAM_DESCRIPTION
#' @param Tbull PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CalcSurvFromNPMLE
#' @export 
CalcSurvFromNPMLE <- function(probs, points, Tbull) {
    .Call('_ICcalib_CalcSurvFromNPMLE', PACKAGE = 'ICcalib', probs, points, Tbull)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param beta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param psDeriv PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CalcUbetabeeta
#' @export 
CalcUbetabeeta <- function(beta, tm, event, ps, psDeriv) {
    .Call('_ICcalib_CalcUbetabeeta', PACKAGE = 'ICcalib', beta, tm, event, ps, psDeriv)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param beta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param psDeriv PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CalcUbetabeetaRS
#' @export 
CalcUbetabeetaRS <- function(beta, tm, event, ps, psDeriv) {
    .Call('_ICcalib_CalcUbetabeetaRS', PACKAGE = 'ICcalib', beta, tm, event, ps, psDeriv)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param betagamma PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param Z PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CoxLogLik
#' @export 
CoxLogLik <- function(betagamma, tm, event, ps, Z) {
    .Call('_ICcalib_CoxLogLik', PACKAGE = 'ICcalib', betagamma, tm, event, ps, Z)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param theta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param Z PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CoxLogLikGrad
#' @export 
CoxLogLikGrad <- function(theta, tm, event, ps, Z) {
    .Call('_ICcalib_CoxLogLikGrad', PACKAGE = 'ICcalib', theta, tm, event, ps, Z)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param theta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @param Z PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CoxLogLikHess
#' @export 
CoxLogLikHess <- function(theta, tm, event, ps, Z) {
    .Call('_ICcalib_CoxLogLikHess', PACKAGE = 'ICcalib', theta, tm, event, ps, Z)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param gamma PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param Z PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CoxLogLikNoBeta
#' @export 
CoxLogLikNoBeta <- function(gamma, tm, event, Z) {
    .Call('_ICcalib_CoxLogLikNoBeta', PACKAGE = 'ICcalib', gamma, tm, event, Z)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param beta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname CoxLogLikX
#' @export 
CoxLogLikX <- function(beta, tm, event, ps) {
    .Call('_ICcalib_CoxLogLikX', PACKAGE = 'ICcalib', beta, tm, event, ps)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param w PARAM_DESCRIPTION
#' @param wres PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname FindIntervalCalibCPP
#' @export 
FindIntervalCalibCPP <- function(w, wres) {
    .Call('_ICcalib_FindIntervalCalibCPP', PACKAGE = 'ICcalib', w, wres)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param w PARAM_DESCRIPTION
#' @param wres PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname FindIntervalCalibCPPvec
#' @export 
FindIntervalCalibCPPvec <- function(w, wres) {
    .Call('_ICcalib_FindIntervalCalibCPPvec', PACKAGE = 'ICcalib', w, wres)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param point PARAM_DESCRIPTION
#' @param w PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname FindIntervalCPP
#' @export 
FindIntervalCPP <- function(point, w) {
    .Call('_ICcalib_FindIntervalCPP', PACKAGE = 'ICcalib', point, w)
}

#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param beta PARAM_DESCRIPTION
#' @param tm PARAM_DESCRIPTION
#' @param event PARAM_DESCRIPTION
#' @param ps PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname myFmyHess
#' @export 
myFmyHess <- function(beta, tm, event, ps) {
    .Call('_ICcalib_myFmyHess', PACKAGE = 'ICcalib', beta, tm, event, ps)
}
yonicd commented

it seems like this is valid comment syntax for a .Call function

yonicd commented

updated makeOxyFile to ask a question if it finds RccpExports.R in the path passed to it. I'll merge it in a day or so unless you raise an issue on how it is done. 0cd81e4

yonicd commented

PR #37