Re: [R] Hiding information about functions in newly developed packages

From: Peter Dalgaard <p.dalgaard_at_biostat.ku.dk>
Date: Thu, 17 Jul 2008 18:55:03 +0200

Tudor Bodea wrote:
> Dear UseRs:
>
> I intend to write a package to handle the basic operations a revenue management
> analyst has to deal with on a regular basis (e.g., demand untruncation,
> capacity allocation, pricing decisions, etc.). Following the directions posted
> by Peter Rossi (Making R Packages under Windows: A Tutorial, January 2006) I
> was able to build an interim package that currently consists of one simple
> function (e.g., fun). After the package is loaded and the function is invoked
> without any parameters (e.g., > fun) the body of the function is displayed on
> the screen underneath the function call. Since the user does not need to know
> the internal structure of the function, I am wondering if there is a way to
> hide this information. I have looked into some of the material that Paul
> Murrell and John Chambers among others posted but I have not really understood
> how to incorporate this information into the package building process. If you
> already experienced this issue and have some useful suggestions, I would really
> appreciate your taking the time to share them with me. For this project, I am
> using R2.7.1 on a Windows XP machine.
>
A simple way is

 > print.invisible <- function(x) cat("Printing disabled\n")
 > class(ls) <- "invisible"
 > ls

Printing disabled

Of course, unclass(ls) still shows the definition, but I assume that the purpose was never to hide the progamming, just to avoid confusing users. Also of course, the same thing applies to all other functions in the system....

And, btw, "fun" is not "invoking the function without parameters", that would be "fun()". Typing the name is a request to see the function object.

-- 
   O__  ---- Peter Dalgaard             ุster Farimagsgade 5, Entr.B
  c/ /'_ --- Dept. of Biostatistics     PO Box 2099, 1014 Cph. K
 (*) \(*) -- University of Copenhagen   Denmark      Ph:  (+45) 35327918
~~~~~~~~~~ - (p.dalgaard_at_biostat.ku.dk)              FAX: (+45) 35327907

______________________________________________
R-help_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.
Received on Thu 17 Jul 2008 - 17:23:02 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Thu 17 Jul 2008 - 18:31:43 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-help. Please read the posting guide before posting to the list.

list of date sections of archive