Submitted by nsicad on Mon, 07/19/2010 - 20:46
Posted in
Kyle,
I discover that Rhelp files in R packages is just a type file format with some weird encoding for the bracket or #, (I don't know). You can open it in the text editor. It is probably full documented, the encoding of this Rhelp. I know that R is moving to html help files but very few developers adopted it. Rhelp file txt is full developed.
The Rhelp file is located in the help directory of the library (i.e. packages).
The Rhelp files contains all the function of the packages and sample R codes. It is good guide in creating widget functions, etc. in Red-R. I think it is good practice to have consistency of the functions in between R packages and Red-R widgets, in my opinion.
This is the answer to your questions what are the functions of RGDAL. Just installed RGDAL in Red-R. How do we install of R packages in Red-R, so we can see the functions?
You can also see how it is use in actually R script / codes at the bottom of the individual files.
The good thing about these Rhelp files is you can read with right encoding and loaded it in Red-R help / documentation widgets. You just needed load button for Rhelp in Widget, if you like. I think nothing much on help for the Red-R widgets. Doing this will significant improve the Red-R help and widget functions.
Have a look at the Rhelp files of Maptools, you can see the other functions aside 2 function / widget that you have already developed.
I wish at this stage I have already good python programming skills :-).
Anyway, have a look of the things that I mentioned above.
1. Rhelp file for Red-R documentation / help
2. functions for the Red-R widget development
3. Sample R script / codes
The Rhelp file encoding is probably in this chapter, Writing R documentation files
http://cran.r-project.org/doc/manuals/R-exts.pdf
Thanks. Noli
For end users it is expected that they know the R function that they would like to replicate. R provides the help files for this anyway so there is really nothing we can do to change R documentation.
I use Red-R quite a bit in my own work but our goal is for users to NOT have to know much about scripting. Sure, this information might be helpful in documentation and I include this in my own widgets when I can but a custom help file for the widgets is generally better.
R help files are also included when an end user downloads the R part of the package so they really always have the R help files exactly as you asked for in the above post.
Examining Red-R code will show you that widgets are not R, nor is Red-R core R. Red-R is python that formats strings for R. If you like R you might like to use Red-R because you can do things in an automated way and have a nice GUI that wraps around R. When we run a function in a widget what happens near the end is something like;
execute this code in R: 'variable<-function(parameters)'
If you don't know anything about R and want to have a powerful statistical environment that doesn't cost you anything and has a GUI for lots of functions then you might really like Red-R because we run the powerful statistical engine R under a GUI front end.
This is all documented on the developer section of the site and I would encourage you to take a look at that.
R help is really nice, I use that all the time when I am making widgets. WidgetMaker actually also uses elements of R help to make widgets with. But there wouldn't be much use in putting all R help files with Red-R since a developer would be making the widgets and would have to know the function that she wanted to use for the widget and would have to have a working version of the package in Red-R (again using widget maker which will install R packages for you) which would also come with help.
Thanks for your post.
Kyle
I am not referring to the end users of the widgets, I am referring to how Red-R widget developers could take advantage on the help files to recreate those functions in their widgets. The posting was intended to widget developers, not end user of the Red-R widgets.
Regarding, R help files not applicable to widget function. I think, you should put a notice - a disclosure that the R help is only applicable to R but not Red-R. The R help would help Red-R user understand how this widget that he is using now is used in R script.
It is a mixed bag here, I think most of people who would be using Red-R knows a bit how to write R package scripts and could benefit the R help.
For the new user of Red-R, I don't know how it would help.
Noli
Often we do copy and paste the R help files into the widgets. The problem is that widgets may have different functionality than their corresponding R widgets. We do also allow local html help files.
Could you show us exactly what you mean by appropriate documentation, help files, examples, etc. Please create a help file, widget recipe, example, data file, etc. to your liking and send the developers a copy. We know what R help files look like and they have examples and example data that you can use in the packages. I just can't abstract to how that should relate to Red-R help files to explain how to use a widget.
Kyle
Anup,
Thanks for taking the suggestion.
I am not a fan on on-line help system, since you are off-line, you can read the help documentation.
Html file for help is OK, as long as you have these save locally.
But the R help doc is really good. I think it is better than the pdf file of the package. You can see all the functions of the package / library.
I hope you can kind the way to read these R help files without problem and incorporate it in widget.
thanks,
Noli
Noli,
I like your idea of adding the existing R help docs to the widget help. Currently these help files are linked through the red-R website. So you can see the example at https://red-r.org/base-read-files.
I will try to incorporate these into the Red-R application.
Also since you are getting started with Red-R widget development. Take a look at the cor.py file in the libraries/stats/widget directory.
This file has been well documented to show the structure of the red-r widget. Also the full api for widget development is at :
https://red-r.org/development/widget_api
This lists all the functions that are available to create your first widget.
Aside from these functions your widget can use any python/QT code to generate the GUI and execute arbitrarily R code.
Clearly this documentation is work in progress. Please take a look at it and let us know whenever something is confusing or missing.
Thanks,
Anup