[rkward-devel] roxygen2 docs for rkward package

meik michalke Meik.Michalke at uni-duesseldorf.de
Fri Aug 12 14:35:27 UTC 2011


hi,

i've added roxygen2(!) style comments to the functions in the rkward R 
package. not writing new docs, just using Rd2roxygen on the present Rd files. 
i stumbled across this in public.R:

<code>
# utility to convert the rkward meta data of objects created in rkward < 0.4.0
# keep for a few months after 0.4.0 is out
"rk.convert.pre040" <- function (x) {
...
</code>

is that still used?

another question i have is regarding the destinction between "internal" and 
"public". all "internal" functions are actually publicly available, many of 
them are just hidden because their name starts with a dot. is that for a 
reason? if this was not intended, i could add @export tags only where they 
belong.

for the really public functions i would like to split the public.R file into 
one file per linked group of functions, if that's ok.


viele grüße :: m.eik

-- 
  dipl. psych. meik michalke
  abt. f"ur diagnostik und differentielle psychologie
  institut f"ur experimentelle psychologie
  heinrich-heine-universit"at d"usseldorf
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 190 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/rkward-devel/attachments/20110812/4c3c0af3/attachment.sig>


More information about the Rkward-devel mailing list