Re: [Rd] Display instruction text on package load

From: Dirk Eddelbuettel <edd_at_debian.org>
Date: Sun, 08 Apr 2012 08:07:34 -0500

On 7 April 2012 at 16:27, Thomas J. Leeper wrote:
| I'm currently working on a new package for R that interfaces with an API.
| Most of the package's functionality requires users to supply an access key
| that allows the package to work with the API. I want to display text
| immediately upon loading the package that instructs/reminds users to enter
| their access key before attempting to do anything (as the package won't
| really work without it). I've searched the relevant help files for creating
| packages but haven't been able find anything about how to do this. As an
| example, library(Zelig) does what I'm trying to achieve.

Start with

      help(packageStartupMessage)
      help(.onLoad)

and also peruse the list archives here---you probably want this in your .onLoad() function.

Maybe some of the packages interfacing Google's APIs and webservices have an example.

Dirk

-- 
R/Finance 2012 Conference on May 11 and 12, 2012 at UIC in Chicago, IL
See agenda, registration details and more at http://www.RinFinance.com

______________________________________________
R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Received on Sun 08 Apr 2012 - 13:09:40 GMT

This quarter's messages: by month, or sorted: [ by date ] [ by thread ] [ by subject ] [ by author ]

All messages

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 Sun 08 Apr 2012 - 13:20:41 GMT.

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

list of date sections of archive