addHooksToPrint: Add 'archivist' Hooks to 'rmarkdown' Reports

Description Usage Arguments Contact Note Author(s) References See Also Examples

View source: R/addArchivistHooks.R

Description

addHooksToPrint adds an overloaded version of the print function for objects of selected class. The overloaded function will add all objects of selected class to the Repository and then will add hooks (to the Remote or Local Repository) to the HTML report (generated in rmarkdown) for these objects (artifacts - archivist-package). The great example can be seen in this blogpost http://www.r-bloggers.com/why-should-you-backup-your-r-objects/.

Usage

1
2
3
4
addHooksToPrint(class = "ggplot", repoDir = aoptions("repoDir"),
  repo = aoptions("repo"), user = aoptions("user"),
  branch = "master", subdir = aoptions("subdir"),
  format = "markdown")

Arguments

class

A character with a name of class (one or more) that should be archived.

repoDir

A character containing a name of a Local Repository.

repo

A character with a name of a Remote repository on which the Repository is archived. If repo = NULL then hooks will be added to files in local directories.

user

A character with a name of a Remote-repository user on whose account the repo is created.

branch

A character with a name of Remote-repository's branch on which the Repository is archived. Default branch is master.

subdir

A character with a name of a subdirectory on a Remote repository on which the Repository is stored. If the Repository is stored in main folder on a Remote repository, this should be set to subdir = "/" as default.

format

A character denoting format as in alink.

Contact

Bug reports and feature requests can be sent to https://github.com/pbiecek/archivist/issues

Note

One can specify userTags as in saveToLocalRepo for artifacts by adding "tags" attribute. See note secion about that in saveToLocalRepo.

Author(s)

Przemyslaw Biecek, przemyslaw.biecek@gmail.com

References

Biecek P and Kosinski M (2017). "archivist: An R Package for Managing, Recording and Restoring Data Analysis Results." _Journal of Statistical Software_, *82*(11), pp. 1-28. doi: 10.18637/jss.v082.i11 (URL: http://doi.org/10.18637/jss.v082.i11). URL https://github.com/pbiecek/archivist

See Also

Other archivist: Repository, Tags, %a%, addTagsRepo, aformat, ahistory, alink, aoptions, archivist-package, areadLocal, aread, asearchLocal, asearch, asession, atrace, cache, copyLocalRepo, createLocalRepo, createMDGallery, deleteLocalRepo, getRemoteHook, getTagsLocal, loadFromLocalRepo, md5hash, removeTagsRepo, restoreLibs, rmFromLocalRepo, saveToLocalRepo, searchInLocalRepo, setLocalRepo, shinySearchInLocalRepo, showLocalRepo, splitTagsLocal, summaryLocalRepo, zipLocalRepo

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# only in Rmd report, links to github repository
addHooksToPrint(class="ggplot", repoDir = "arepo",
repo="graphGallery", user="pbiecek")
# only in Rmd report, links to local files
addHooksToPrint(class="ggplot", repoDir = "arepo",
repo=NULL)

## End(Not run)

archivist documentation built on Aug. 31, 2019, 5:05 p.m.