writeManPage           package:AnnBuilder           R Documentation

_F_u_n_c_t_i_o_n_s _t_h_a_t _w_r_i_t_e _s_u_p_p_o_r_t_i_n_g _f_i_l_e_s _n_e_e_d_e_d _b_y _a _d_a_t_a _p_a_c_k_a_g_e

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

     The functions are mainly used to write man pages and supporting
     functions that are needed for a data package

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

     writeManPage(pkgName, pkgPath, manName, organism = "human", src = "ll",
     isEnv = TRUE) 
     writeMan4Fun(pkgName, pkgPath, organism = "human", QCList, dSrc = "all" )
     formatName(toFormat)
     writeREADME(pkgPath, pkgName, urls)
     writeDescription(pkgName, pkgPath, version, author, dataSrc, license)
     getDSrc(organism)
     getSrcNBuilt(dSrc, organism)
     getUrlNBuilt(src, organism)
     writeAccessory(pkgName, pkgPath, organism, version, author = list(author =
     "who", maintainer = "who@email.net"), dataSrc, license)
     writeFun(pkgPath, pkgName, organism = "human")
     writeZZZ(pkgPath, pkgName)
     getAllRdaName(pkgName, pkgPath)
     escapeLatexChr(item)
     writeMan4QC(pkgName, pkgPath)
     getExample(pkgName, manName, isEnv = TRUE)
     getSrcBuiltNRef(src, organism)
     getBuild4Yeast(src, manName)

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

 pkgName: A character string for the name of a data package or R
          library

 pkgPath: A character string for the path where pkgname resides

organism: A character string for the name of the organism of interests

toFormat: A character string form whom any underscore will be removed

    urls: A vector of character of string for the urls of the data
          source used to create the rda files

    dSrc: A vector of character strings containing the short names of
          public data sources (e. g. LL for LocusLink)

     src: A character string for the short name of a public data source

 version: A character string for the version number

  author: A named vector of strings with two elements named name and
          address, respectively. Name is a character string for the
          name of the person who maintains the data package and address
          is the email address of the person

    item: A character string to be escaped by if it is a latex
          character

  QCList: A list with statistical data derived from 'getDPStats'

 manName: 'manName' a character string for the name of the man page to
          be created

   isEnv: 'isEnv' a boolean to indicate whether the object a man page
          concerns is an R environment or not

 dataSrc: 'dataSrc' a vector of character strings for the data sources
          used to create a package

 license: 'license' a character string for the license the package is
          under

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

     If pkgname = "XX" and elenames = "yy", the Rd file will be
     "XXyy.Rd" appended to the path if short is FALSE. Otherwise, the
     Rd file will be "yy.Rd" appended to the path.

     'writeManPage' writes a man page for a given object that is stored
     in the data directory.

     'getExample' creates a set of example code that is going to be
     used in a man page depending on whether the man page is for an
     environment object or not.

     'getSrcBuiltNRef' creates the text that is going to be used for
     built and reference information in a man page.

     'getBuild4Yeast' creates the text that is going to be used for
     built and reference information for the man page for yeast.

_V_a_l_u_e:

     All functions return a character string.

_N_o_t_e:

     The functions are part of the Bioconductor project at Dana-Farber
     Cancer Institute to provide BioInformatics functionalities through
     R

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

     Jianhua Zhang

_R_e_f_e_r_e_n_c_e_s:

     An Introduction to R - Writing R Extensions

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

     'ABPkgBuilder'

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

     ## Not run: 
     makeSrcInfo()
     dir.create(file.path(".", "pkg"))
     dir.create(file.path(".", "pkg", "data"))
     dir.create(file.path(".", "pkg", "man"))
     writeManPage("pkg", getwd(), "CHR")
     list.files(file.path(getwd(), "pkg", "data"))
     unlink("pkg", TRUE)
     ## End(Not run)

