write_VIEWS            package:biocViews            R Documentation

_W_r_i_t_e _a _V_I_E_W_S _c_o_n_t_r_o_l _f_i_l_e _f_o_r _a _C_R_A_N-_s_t_y_l_e _p_a_c_k_a_g_e _r_e_p_o_s_i_t_o_r_y

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

     This function writes a 'VIEWS' file to the top-level of a
     CRAN-style package repository.  The 'VIEWS' file is in DCF format
     and describes all packages found in the repository.

     The 'VIEWS' file contains the complete 'DESCRIPTION' file for each
     source package in the repository.  In addition, metadata for
     available binary packages and vignettes is centralized here.

_U_s_a_g_e:

     write_VIEWS(reposRootPath, fields = NULL, type = c("source", "mac.binary", "win.binary"), verbose = FALSE, vignette.dir = "vignettes")

_A_r_g_u_m_e_n_t_s:

reposRootPath: character vector containing the path to the CRAN-style
          repository root directory.

  fields: Any additional fields to include.  You shouldn't need this,
          but if you have added fields to the DESCRIPTION files of the
          packages in the repository, you may want it.

    type: One of 'source', 'mac.binary', or 'win.binary' indicating
          which set of packages should be used to build up the "shared"
          information.  Since a repository can contain different
          versions of the same package (source vs binary) the shared
          information may be a lie.

 verbose: logical, if 'TRUE', print progress messages.

vignette.dir: character specifying where to look for vignettes.

_W_a_r_n_i_n_g:

     This function uses a private function from the 'tools' package:
     'tools:::.build_repository_package_db'.

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

     Seth Falcon

_S_e_e _A_l_s_o:

     'write_PACKAGES', 'extractVignettes',
     'link{genReposControlFiles}', 'write_REPOSITORY'

