package.skeleton            package:utils            R Documentation

_C_r_e_a_t_e _a _S_k_e_l_e_t_o_n _f_o_r _a _N_e_w _S_o_u_r_c_e _P_a_c_k_a_g_e

_D_e_s_c_r_i_p_t_i_o_n:

     'package.skeleton' automates some of the setup for a new source
     package.  It creates directories, saves functions and data to
     appropriate places, and creates skeleton help files and 'README'
     files describing further steps in packaging.

_U_s_a_g_e:

     package.skeleton(name = "anRpackage", list, environment = .GlobalEnv,
                      path = ".", force = FALSE)

_A_r_g_u_m_e_n_t_s:

    name: character string: the directory name for your package.

    list: character vector naming the R objects to put in the package.

environment: if 'list' is omitted, the contents of this environment are
          packaged.

    path: path to put the package directory in.

   force: If 'FALSE' will not overwrite an existing directory.

_D_e_t_a_i_l_s:

     The package sources are placed in subdirectory 'name' of 'path'.

     This tries to create filenames valid for all OSes known to run R.
     Invalid characters are replaced by '_', invalid names are preceded
     by 'zz', and finally the converted names are made unique by
     'make.unique(sep = "_")'.  This can be done for code and help
     files but not data files (which are looked for by name).

_V_a_l_u_e:

     used for its side-effects.

_R_e_f_e_r_e_n_c_e_s:

     Read the _Writing R Extensions_ manual for more details.

     Once you have created a _source_ package you need to install it:
     see the _R Installation and Administration_ manual, 'INSTALL' and
     'install.packages'.

_S_e_e _A_l_s_o:

     'prompt'

_E_x_a_m_p_l_e_s:

     ## two functions and two "data sets" :
     f <- function(x,y) x+y
     g <- function(x,y) x-y
     d <- data.frame(a=1, b=2)
     e <- rnorm(1000)

     package.skeleton(list=c("f","g","d","e"), name="mypkg")

