makeAll: Generate news, celfiles, and help for website

Description Usage Arguments Value Note Author(s) Examples

Description

Utility functions for generating the News.html, celfiles.zip, and howto.html files used in the website from NEWS.Rd, the celfiles in "inst/extdata/celfiles", and vignettes/howto.Rmd, respectively. Intented primarily for internal use.

Usage

1
2
3
4
5
6
7
makeAll(makeCelfiles = FALSE)

makeNews(indir = "inst", outdir = "inst/website/www")

makeCelfiles(outdir = "inst/website/www")

makeHowto(indir = "vignettes", outdir = "inst/website/www", ...)

Arguments

makeCelfiles

logical. Should makeCelfiles() be executed. Default FALSE is faster.

indir

The input directory to read the files from.

outdir

The output directory to write the files to.

...

Arguments passed to knitr:knit2html.

Value

Writes to files in outdir. Invisibly returns the path to the written file.

Note

The functions assumes by default that the working directory is the root of the local hemaClass package.
The functions overwrites all previously present files.

Author(s)

Anders Ellern Bilgrau

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
makeAll()

# makeAll is an alias for:
makeNews()
makeCelfiles()
makeHowto()

## End(Not run)

oncoclass/hemaClass documentation built on May 24, 2019, 2:19 p.m.