Skip to content

[Rcpp-devel] using Roxygen2 in a methods exported via a module

3 messages · Robin Girard, Romain Francois, Dirk Eddelbuettel

#
Hi list, 
I have a c++ class and associated methods in my package wich are exported through a module, but I cannot find how to export the documentation of the method and the class. I am using Rcpp  10.3, Roxygen2, ... 
Note that when I use module to export a function (not a method from my class) the export works like a charm. 

any idea of what I'm doing wrong ? 

Best 
R.


Dr. Girard Robin
Charg? de Recherche

MINES-ParisTech / D?partement Energ?tique et Proc?d?s / PERSEE / Groupe ERSEI
Centre Proc?d?s, Energies Renouvelables et Syst?mes Energ?tiques (PERSEE)
Center for Processes, Renewables Energies and Energy Systems
Renewable Energies & Smartgrids (ERSEI)

1 Rue Claude Daunesse - CS 10207 - F-06904 Sophia Antipolis Cedex
Tel: +33.4.93.67.89.64 (~99), Fax: +33.4.93.95.75.35
e-mail : robin.girard at mines-paristech.fr

web page perso http://www.mines-paristech.fr/Services/Annuaire/&?id=8828
statoverflow : http://stats.stackexchange.com/users/223/robin-girard
web page centre PERSEE : http://www.cep.mines-paristech.fr/
linkedin : http://www.linkedin.com/profile/view?id=14907272&trk=tab_pro

Le lien vaut mieux que le bien.
________________________________________________________

CONFIDENTIALITY : This  e-mail  and  any attachments are
confidential and may be privileged. If  you are not a
named recipient, please notify the sender immediately and
do not disclose the contents to another person, use it for
any purpose or store or copy the information in any medium.

CONFIDENTIALITE : Ce message et les ?ventuelles pi?ces
attach?es sontconfidentiels et peuvent ?tre une
communication prot?g?e. Si vous n'?tes pas dans la liste
des destinataires, veuillez informer l'exp?diteur
imm?diatement et ne pas ouvrir ni divulguer le contenu
? une tierce personne, ne pas l'utiliser pour quelque
raison que ce soit, ne pas stocker ou copier l'information
qu'il contient sur un quelconque support.
#
Hello,

This is just not supported (yet).

Romain

Le 2013-03-29 09:39, Robin Girard a ?crit?:
#
On 29 March 2013 at 09:44, romain at r-enthusiasts.com wrote:
| 
| Hello,
| 
| This is just not supported (yet).

I'd rather say:  "This was never supported nor announced to be supported."
Unless I am forgetting something here.

The "(yet)" has the same meaning here as stating that every conceivable
extension has a non-zero chance of being added --- simply because there are
no events with truly zero p-values...

| Romain
| 
| Le 2013-03-29 09:39, Robin Girard a ?crit?:
| > Hi list,
| > I have a c++ class and associated methods in my package wich are
| > exported through a module, but I cannot find how to export the
| > documentation of the method and the class. I am using Rcpp  10.3,
| > Roxygen2, ...
| > Note that when I use module to export a function (not a method from
| > my class) the export works like a charm.
| >
| > any idea of what I'm doing wrong ?

Probably simply not reading the documentation carefully enough.

Dirk


| >
| > Best
| > R.
| >
| >
| > Dr. Girard Robin
| > Charg? de Recherche
| >
| > MINES-ParisTech / D?partement Energ?tique et Proc?d?s / PERSEE / 
| > Groupe ERSEI
| > Centre Proc?d?s, Energies Renouvelables et Syst?mes Energ?tiques 
| > (PERSEE)
| > Center for Processes, Renewables Energies and Energy Systems
| > Renewable Energies & Smartgrids (ERSEI)
| >
| > 1 Rue Claude Daunesse - CS 10207 - F-06904 Sophia Antipolis Cedex
| > Tel: +33.4.93.67.89.64 (~99), Fax: +33.4.93.95.75.35
| > e-mail : robin.girard at mines-paristech.fr
| >
| > web page perso 
| > http://www.mines-paristech.fr/Services/Annuaire/&?id=8828
| > statoverflow : http://stats.stackexchange.com/users/223/robin-girard
| > web page centre PERSEE : http://www.cep.mines-paristech.fr/
| > linkedin : 
| > http://www.linkedin.com/profile/view?id=14907272&trk=tab_pro
| >
| > Le lien vaut mieux que le bien.
| > ________________________________________________________
| >
| > CONFIDENTIALITY : This  e-mail  and  any attachments are
| > confidential and may be privileged. If  you are not a
| > named recipient, please notify the sender immediately and
| > do not disclose the contents to another person, use it for
| > any purpose or store or copy the information in any medium.
| >
| > CONFIDENTIALITE : Ce message et les ?ventuelles pi?ces
| > attach?es sontconfidentiels et peuvent ?tre une
| > communication prot?g?e. Si vous n'?tes pas dans la liste
| > des destinataires, veuillez informer l'exp?diteur
| > imm?diatement et ne pas ouvrir ni divulguer le contenu
| > ? une tierce personne, ne pas l'utiliser pour quelque
| > raison que ce soit, ne pas stocker ou copier l'information
| > qu'il contient sur un quelconque support.
| > _______________________________________________
| > Rcpp-devel mailing list
| > Rcpp-devel at lists.r-forge.r-project.org
| > 
| > https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/rcpp-devel
| 
| _______________________________________________
| Rcpp-devel mailing list
| Rcpp-devel at lists.r-forge.r-project.org
| https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/rcpp-devel