[rkward-devel] [rkward-cvs] SF.net SVN: rkward:[4180] trunk/rkward/rkward/rbackend/rpackages/rkward/R

[Thomas Friedrichsmeier]

Hi,

On Thursday 15 March 2012, m-eik at users.sourceforge.net wrote:
> Revision: 4180
>           http://rkward.svn.sourceforge.net/rkward/?rev=4180&view=rev
> Author:   m-eik
> Date:     2012-03-15 11:55:36 +0000 (Thu, 15 Mar 2012)
> Log Message:
> -----------
> added "#' @export" tags to functions which later should be exported when
> the package gets a proper namespace

good idea. Perhaps we should finally start working on a namespace, indeed. It 
does look like R will not necessarily support packages without a formal 
namespace declaration for much longer.

Perhaps the following would be a workable plan for a smooth transition:

1) Add '@export' tags to *all* functions (did you already do that?)

2) For all functions starting with a dot, add some marker like '#TODO REVIEW 
EXPORT' on the '@export'-line to remind us that we will have to check whether 
it is really necessary to export these.

3) Let roxygen generate a NAMESPACE file from that, second check it for 
correctness, and activate it. Make sure that everything seems to be working 
(not sure, whether we may have to define some imports, too).

4) Over time, we will take a look at the functions marked for review, one by 
one, and check whether / how they can be hidden from the export. (Is there a 
corresponding tag like '@internal', '@private', '@noexport' or something in 
roxygen? Otherwise, perhaps we should make up one ourselves, to avoid 
ambiguities).

What do you think?

Regards
Thomas
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/rkward-devel/attachments/20120319/ec5475ec/attachment.sig>