Currently, several readers, jay, sanger, can’t be saved to sql file, becasue they are missing the “electrode.num” column in layout$pos matrix. See the code in iit.R where this is solved:
file:R/iit.R::electrode.num <- ((r-1)*64) + c ## start electrodes from number 1
this currently looks like an S3 method, calling “hist” on objects of class “ab”.
2014-05-16. Started the process of converting documentation to roxygen. The “Rd2roxygen” package on cran was great for this, as it converts .Rd files and guesses where to put the documentation in the R folder. If it can’t find a home, it puts it in the -package.R file.
Just remember to do:
options(roxygen.comment = “##’ “)
to keep Emacs happy.
However, as I have been bad about adding documentation for everything, I couldn’t get it to update the NAMESPACE file (which provides the exports). I think the solution will be to do the updating of the R scripts in a piecemeal fashion.
To prevent NAMESPACE file being overwritten, do
require(devtools) devtools::document(pkg=”~/langs/R/sjemea”, roclets=”rd”) check_doc()
although it seems now it doesn’t overwrite NAMESPACE if it sees I’ve edited it?
Chris Wallace lists some neat examples of this in use:
http://cwcode.wordpress.com/2013/01/28/developing-r-packages-using-roxygen-and-devtools/
in particular, the @inheritParams tag allows you to copy parameters from other functions. This should save a lot of typing!