R: How to run some code on load of package?

r r-package
xiaodai picture xiaodai · Nov 26, 2013 · Viewed 7.2k times · Source

I am learning to build a package for R. Now to set it up I need to run some code when the package is being loaded via require(myPackage).

I read the documentation on help(".onLoad") that just made me really confused as there is no example. How do I actually use .onLoad?

Can someone please show me a simple example? For example I know export(myfun) in the NAMESPACE file will export myfun for use, what is the code that I need to run say rnorm(10) at package load?

Answer

agstudy picture agstudy · Nov 26, 2013

There is usually a "processing function" (traditionally called zzz.R) with tasks to be performed when the package is loaded, such as loading libraries and compiled code. For example you can create a zzz.R file where you create this function:

.onLoad <- function(libname, pkgname){
  x <- rnorm(10)   ## dummy example 
}

Related questions

How to load packages in R automatically?

Could you suggest me a way for loading packages in R automatically? I mean, I want to start a session in R without needing to use library('package name') several times. Suppose I downloaded all packages I'll want to use …

Read More
Creating a local R package repository

I would like to create a local R package repository such that users in my company can install packages from it and the system admins can update the local repo periodically. Access to the CRAN mirrors is currently denied. Is …

Read More
Can't download data from Yahoo Finance using Quantmod in R

I'm trying to download data from Yahoo using this code: library(quantmod) getSymbols("WOW", auto.assign=F) This has worked for me in the past in every occasion except now, 5 days before my group assignment is due. Except now I …

Read More