PackageDetail-class        package:biocViews        R Documentation

_C_l_a_s_s "_P_a_c_k_a_g_e_D_e_t_a_i_l"

_D_e_s_c_r_i_p_t_i_o_n:

     Representation of R package metadata.  Most slots correspond to
     fields in a package's DESCRIPTION file.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects can be created by calls of the form 'new("PackageDetail",
     ...)'.

_S_l_o_t_s:

     '_P_a_c_k_a_g_e': Object of class '"character"' see DESCRIPTION 

     '_V_e_r_s_i_o_n': Object of class '"character"'  see DESCRIPTION 

     '_T_i_t_l_e': Object of class '"character"'  see DESCRIPTION 

     '_D_e_s_c_r_i_p_t_i_o_n': Object of class '"character"'  see DESCRIPTION 

     '_A_u_t_h_o_r': Object of class '"character"' see DESCRIPTION 

     '_M_a_i_n_t_a_i_n_e_r': Object of class '"character"' see DESCRIPTION 

     '_D_e_p_e_n_d_s': Object of class '"character"' see DESCRIPTION 

     '_S_u_g_g_e_s_t_s': Object of class '"character"' see DESCRIPTION 

     '_I_m_p_o_r_t_s': Object of class '"character"' see DESCRIPTION 

     '_S_y_s_t_e_m_R_e_q_u_i_r_e_m_e_n_t_s': Object of class '"character"' see
          DESCRIPTION 

     '_L_i_c_e_n_s_e': Object of class '"character"' see DESCRIPTION 

     '_U_R_L': Object of class '"character"' see DESCRIPTION 

     '_b_i_o_c_V_i_e_w_s': Object of class '"character"' see DESCRIPTION 

     '_v_i_g_n_e_t_t_e_s': Object of class '"character"' giving paths to
          vignette pdf files in the repository 

     '_s_o_u_r_c_e._v_e_r': Object of class '"character"' version string for the
          source package

     '_w_i_n._b_i_n_a_r_y._v_e_r': Object of class '"character"' version string for
          the Windows binary package 

     '_m_a_c._b_i_n_a_r_y._v_e_r': Object of class '"character"' version string for
          the OS X binary package 

     '_m_a_n_u_a_l_s': Object of class '"character"' Not used. Intended to
          hold paths to pdf manuals in the repository

     '_d_e_p_e_n_d_s_O_n_M_e': Object of class '"character"' giving packages found
          in the repository that depend on this package

     '_s_u_g_g_e_s_t_s_M_e': Object of class '"character"' giving packages found
          in the repository that suggest this package

     '_f_u_n_c_t_i_o_n_I_n_d_e_x': Object of class '"character"' Not used.  Intended
          to hold function index data. 

     '_r_e_p_o_s_R_o_o_t': Object of class '"character"' The URL for the root of
          the repository. 

_E_x_t_e_n_d_s:

     Class '"Htmlized"', directly.

_M_e_t_h_o_d_s:

     _h_t_m_l_D_o_c 'signature(object = "PackageDetail")': Return an 'XMLNode'
          instance containg a complete HTML document representation of
          the package.

     _h_t_m_l_F_i_l_e_n_a_m_e 'signature(object = "PackageDetail")': Return a
          filename appropriate for the HTML document representation. 

     _h_t_m_l_V_a_l_u_e 'signature(object = "PackageDetail")': Return 'XMLNode'
          instance containing an HTML representation of the package. 

_D_e_t_a_i_l_s:

     'pdAuthorMaintainerInfo-class' 'pdVignetteInfo-class'
     'pdDownloadInfo-class' 'pdDetailsInfo-class'
     'pdDescriptionInfo-class' 'pdVigsAndDownloads-class'

     Dummy classes for HTML generation.  Each dummy class is a simple
     extension (it does not add any slots).  The purpose of each dummy
     class is to allow for method dispatch to generate HTML via the
     'htmlValue' method.

     You can convert convert a 'PackageDetail' instance to one of the
     dummy classes like this: 'descInfo <- as(pdObj,
     "pdDescriptionInfo")'

_A_u_t_h_o_r(_s):

     Seth Falcon

_E_x_a_m_p_l_e_s:

     pd <- new("PackageDetail",
               Package="MyFancyPackage",
               Version="1.2.3",
               Title="A Fancy Package",
               Description="This package does fancy things",
               Author="A. Coder",
               Maintainer="A. Coder <acoder@foo.bar.net>",
               Depends="methods",
               vignettes=c("vignettes/MyFancyPackage/inst/doc/MFP1.pdf",
                 "vignettes/MyFancyPackage/inst/doc/MFP2.pdf"),
               source.ver="src/contrib/MyFancypackage_1.2.3.tar.gz",
               win.binary.ver="bin/windows/contrib/2.3/MyFancyPackge_1.2.2.zip",
               dependsOnMe="AnEvenFancierPackage",
               reposRoot="http://foo.bar.org")

     html <- htmlValue(pd)
     pd

