genRepos {reposTools}R Documentation

A function to create a repository

Description

This functionality provides the user with the means to generate a repository out of a set of files.

Usage

genRepos(repName, urlBase, urlPath, repType=c("package","vignette"),
         repRelLevel=c("release","devel"), dir = ".", HTML=TRUE, functionDesc=FALSE)

Arguments

repName The name of the repository
urlBase A base URL for the repository (e.g. http://www.bioconductor.org/)
urlPath A path from the urlBase (e.g. packages/download/)
repType The type of repository, either package or vignette. Defaults to package
repRelLevel The default release level for packages in this repository. Packages that don't have a ReleaseLevel field in their DESCRIPTION file will be of this release level. The default is release.
dir The directory to create the repository in
HTML For package repositories, toggles HTML generation
functionDesc Whether or not to create an HTMLized version of Rdindex.

Details

For more detailed information, the user is directed to the vignette file "HOWTO set up a simple R repository" in the reposTools package. To do this, you can use the vignette command in the annotate package: vignette("HOWTO set up a simple R repository", package="reposTools").

genRepos is passed basic information about the repository as well as indicators as to what should be autogenerated or manually inputed, and will create two files: One file 'replisting', which contains a matrix of repository information and the other 'repdatadesc.rda' which contains a data.frame representing the files to be distributed. These two special files are accessed by client functions.

HTM generation uses the genReposHTML function.

Value

genRepos returns a list containing basic information about the repository generated.

Author(s)

Jeff Gentry

See Also

install.packages2,ReposEntry, genReposHTML

Examples






[Package reposTools version 1.8.0 Index]