makeDataPackage           package:Biobase           R Documentation

_M_a_k_e _a_n _R _p_a_c_k_a_g_e _f_r_o_m _a _d_a_t_a _o_b_j_e_c_t

_D_e_s_c_r_i_p_t_i_o_n:

     This generic creates a valid R package from an R data object.

_U_s_a_g_e:

     makeDataPackage(object, author, email,
                     packageName=deparse(substitute(object)),
                     packageVersion=package_version("1.0.0"),
                     license="Artistic-2.0",
                     biocViews="ExperimentData",
                     filePath=tempdir(),
                     ...)

_A_r_g_u_m_e_n_t_s:

  object: An instance of an R data object.

  author: The author, as a character string.

   email: A valid email address for the maintainer, as a character
          string.

packageName: The name of the package, defaults to the name of the
          object instance.

packageVersion: The version number, as a character string.

 license: The license, as a character string.

biocViews: A character vector of valid biocViews views.

filePath: The location to create the package.

     ...: Additional arguments to specific methods.

_D_e_t_a_i_l_s:

     The function makes use of various tools in R and Bioconductor to
     automatically generate the source files for a valid R package.

_V_a_l_u_e:

     The return value is that from a call to 'link{createPackage}'
     which is invoked once the default arguments are set up. The data
     instance is stored in the data directory with a name the same as
     that of the resulting package.

_N_o_t_e:

     Developers implementing derived methods might force correct
     package name evaluation by including 'packageName' in any
     'callNextMethod()'.

_A_u_t_h_o_r(_s):

     R. Gentleman

_S_e_e _A_l_s_o:

     'createPackage'

_E_x_a_m_p_l_e_s:

      data(sample.ExpressionSet)
      ## package created in tempdir()
      s1 <- makeDataPackage(sample.ExpressionSet,
                            author = "Foo Author",
                            email = "foo@bar",
                            packageName = "FooBarPkg",
                            packageVersion = "1.0.0")

