packagedocs: Build Website of Package Documentation
Version 0.4.0

Build a package documentation and function reference site and use it as the package vignette.

AuthorRyan Hafen [aut, cre], Barret Schloerke [aut], Hadley Wickham [aut, cph] (Rd munging code from staticdocs package (see comments in 'z_staticdocs' source))
Date of publication2016-11-04 00:41:33
MaintainerRyan Hafen <rhafen@gmail.com>
LicenseMIT + file LICENSE
Version0.4.0
URL http://hafen.github.io/packagedocs https://github.com/hafen/packagedocs
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("packagedocs")

Getting started

README.md
packagedocs
packagedocs

Popular man pages

build_vignettes: Build CRAN and gh-pages vignettes
check_output: Check output for warnings and errors
check_rd_index: Check rd_index.yaml for missing or extra topics
package_docs: Generate package docs
read_rmd_yaml: Read .Rmd yaml header
render_redirect: Render vignette redirect
use_travis: Use Travis CI
See all...

All man pages Function index File listing

Man pages

build_vignettes: Build CRAN and gh-pages vignettes
check_output: Check output for warnings and errors
check_rd_index: Check rd_index.yaml for missing or extra topics
deploy_travis: Deploy to Github Pages from Travis-CI
init_vignettes: Initialize a new packagedocs project
package_docs: Generate package docs
rd_link: Translate a reference to a package function into a link to...
rd_template: Generate the text to put in a rd.rmd file to build a package...
read_rmd_yaml: Read .Rmd yaml header
render_redirect: Render vignette redirect
secure_token: Secure personal access token
to_html: Convert an rdoc to a list of html components.
use_travis: Use Travis CI

Functions

alias_files_from_index Source code
alias_files_from_topics Source code
alias_id_from_index Source code
alias_id_from_topics Source code
alias_info_from_index Source code
all_pkgdocs_engines Source code
as.list.Rd_content Source code
as.sd_package Source code
as_rd_index Source code
as_sd_package Source code
assets_dir Source code
block Source code
build_vignettes Man page Source code
cached_parse_Rd Source code
check_for_pat Source code
check_for_travis_gem Source code
check_output Man page Source code
check_rd_index Man page Source code
clear_cache Source code
compact Source code
deploy_travis Man page Source code
devtools_copy_vignettes_two Source code
display_current_rd_index Source code
docs_file_html Source code
docs_files_dir Source code
extract_alias Source code
extract_name Source code
find_topic Source code
fix_hrefs Source code
get_keyword Source code
get_rd_data Source code
group_fn_by_keyword Source code
html_dependency_boot Source code
html_dependency_fnta Source code
html_dependency_hglt Source code
html_dependency_jquery_easing Source code
html_dependency_packagedocs Source code
html_dependency_sticky_kit Source code
if_null Source code
init_skeleton Source code
init_vignettes Man page Source code
is.sd_package Source code
lazy_widgets_dir Source code
make_alias_id Source code
make_link Source code
onLoad Source code
package_docs Man page Source code
package_docs_rd Man page Source code
package_rd Source code
parse_author_info Source code
parse_descriptions Source code
parse_github_redirect_url Source code
parse_github_ref Source code
parse_github_ref_val Source code
parse_items Source code
parse_rd Source code
parse_section Source code
pkg_sd_path Source code
print.COMMENT Source code
print.RCODE Source code
print.Rd_content Source code
print.TEXT Source code
print.VERB Source code
print.sd_package Source code
rd_file_html Source code
rd_files_dir Source code
rd_link Man page Source code
rd_path Source code
rd_template Man page Source code
read_rmd_yaml Man page Source code
remove_topics_from_index Source code
render_redirect Man page Source code
secure_token Man page Source code
set_class Source code
set_classes Source code
src_highlight Source code
str_replace Source code
tag Source code
to_html Man page Source code
to_html.COMMENT Source code
to_html.NULL Source code
to_html.Rd_content Source code
to_html.Rd_doc Source code
to_html.Sexpr Source code
to_html.TEXT Source code
to_html.alias Source code
to_html.arguments Source code
to_html.author Source code
to_html.character Source code
to_html.concept Source code
to_html.cr Source code
to_html.deqn Source code
to_html.describe Source code
to_html.description Source code
to_html.details Source code
to_html.docType Source code
to_html.dontrun Source code
to_html.dontshow Source code
to_html.email Source code
to_html.enc Source code
to_html.enumerate Source code
to_html.eqn Source code
to_html.examples Source code
to_html.format Source code
to_html.href Source code
to_html.if Source code
to_html.ifelse Source code
to_html.item Source code
to_html.itemize Source code
to_html.keyword Source code
to_html.link Source code
to_html.list Source code
to_html.method Source code
to_html.name Source code
to_html.note Source code
to_html.references Source code
to_html.section Source code
to_html.seealso Source code
to_html.source Source code
to_html.special Source code
to_html.tab Source code
to_html.tabular Source code
to_html.testonly Source code
to_html.title Source code
to_html.url Source code
to_html.usage Source code
to_html.value Source code
topic_index Source code
use_travis Man page Source code
valid_id Source code

Files

inst
inst/html_assets
inst/html_assets/highlight
inst/html_assets/highlight/tomorrow.css
inst/html_assets/highlight/highlight.pack.js
inst/html_assets/template.html
inst/html_assets/fontawesome
inst/html_assets/fontawesome/css
inst/html_assets/fontawesome/css/font-awesome.min.css
inst/html_assets/fontawesome/fonts
inst/html_assets/fontawesome/fonts/fontawesome-webfont.ttf
inst/html_assets/fontawesome/fonts/fontawesome-webfont.eot
inst/html_assets/fontawesome/fonts/FontAwesome.otf
inst/html_assets/fontawesome/fonts/fontawesome-webfont.woff
inst/html_assets/fontawesome/fonts/fontawesome-webfont.woff2
inst/html_assets/fontawesome/fonts/fontawesome-webfont.svg
inst/html_assets/packagedocs
inst/html_assets/packagedocs/pd.css
inst/html_assets/packagedocs/pd.js
inst/html_assets/packagedocs/pd-sticky-toc.js
inst/html_assets/packagedocs/pd-collapse-toc.js
inst/html_assets/bootstrap
inst/html_assets/bootstrap/css
inst/html_assets/bootstrap/css/bootstrap.min.css
inst/html_assets/bootstrap/shim
inst/html_assets/bootstrap/shim/respond.min.js
inst/html_assets/bootstrap/shim/html5shiv.min.js
inst/html_assets/bootstrap/js
inst/html_assets/bootstrap/js/bootstrap.min.js
inst/html_assets/bootstrap/fonts
inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.ttf
inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.svg
inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.woff
inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.eot
inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.woff2
inst/html_assets/sticky-kit
inst/html_assets/sticky-kit/sticky-kit.min.js
inst/html_assets/jquery-easing
inst/html_assets/jquery-easing/jquery.easing.min.js
inst/rd_template
inst/rd_template/cran_template.html
inst/rd_template/rd_template.Rmd
inst/rd_template/rd_main_template.Rmd
inst/doc
inst/doc/rd.html
inst/doc/images
inst/doc/images/github_pat.png
inst/doc/rd.Rmd
inst/doc/docs.Rmd
inst/doc/docs.html
inst/doc/github_pat.png
inst/rmarkdown
inst/rmarkdown/templates
inst/rmarkdown/templates/packagedocs
inst/rmarkdown/templates/packagedocs/skeleton
inst/rmarkdown/templates/packagedocs/skeleton/rd_index.yaml
inst/rmarkdown/templates/packagedocs/skeleton/skeleton.Rmd
inst/rmarkdown/templates/packagedocs/skeleton/rd_skeleton.Rmd
tests
tests/testthat.R
tests/testthat
tests/testthat/test_to_html.R
tests/testthat/test_something.R
NAMESPACE
NEWS.md
R
R/z_staticdocs_highlight.R
R/utils.R
R/on_load.R
R/check_output.R
R/rd_template.R
R/render_shell.R
R/z_staticdocs_rd.R
R/staticdocs.R
R/travis.R
R/devtools.R
R/rd_link.R
R/z_staticdocs_util.R
R/init.R
R/keywords.R
R/package_docs.R
R/z_staticdocs_build-index.R
R/z_staticdocs_to_html.R
R/z_staticdocs_package.R
R/test_file.R
R/packagedocs-package.R
R/purl_docs.R
R/rd_index.R
vignettes
vignettes/rd_index.yaml
vignettes/images
vignettes/images/github_pat.png
vignettes/.install_extras
vignettes/rd.Rmd
vignettes/docs.Rmd
README.md
MD5
build
build/vignette.rds
DESCRIPTION
man
man/rd_template.Rd
man/use_travis.Rd
man/init_vignettes.Rd
man/secure_token.Rd
man/build_vignettes.Rd
man/to_html.Rd
man/read_rmd_yaml.Rd
man/package_docs.Rd
man/check_rd_index.Rd
man/rd_link.Rd
man/deploy_travis.Rd
man/check_output.Rd
man/render_redirect.Rd
.Rinstignore
LICENSE
packagedocs documentation built on May 19, 2017, 3:28 p.m.

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.