Documenting data

[MikkoVihtakari]

One thing we are still lacking is documenting data. I found out that documenting it is rather easy in roxygen2 (http://adv-r.had.co.nz/Documenting-functions.html), but takes some time to get done. One should make an R script for data and write something like following:

' A roi file of type 'line'

'

' Write something here. It becomes description

'

' This line should become details

' @doctype data

' @Format write here too

' @name line.roi

' @Usage how to use the data

NULL

The down side is that this has to be done for each file.

[davidcsterratt]

This sounds like a good idea - but I'd be happy to leave it for a future release, assuming the CRAN maintainers are happy with the package.

[MikkoVihtakari]

I agree. Let's leave this hanging for now.