archivist (version 2.1.1)

createMDGallery: Create the Summary for Each Artifact in a Markdown Format

Description

createMDGallery creates a summary for each artifact from Repository stored on a GitHub. For each artifact tihd function creates a markdown file with: the download link, artifact's Tags (when addTags = TRUE) and miniature (addMiniature = TRUE) if the artifact was archived with it's miniature and Tags. The miniature is a print or head over an artifact or it's png when it was a plot. But this function only supports png miniatures.

Usage

createMDGallery(output, repo = aoptions("repo"), user = aoptions("user"), branch = aoptions("branch"), subdir = aoptions("subdir"), repoType = aoptions("repoType"), addTags = FALSE, addMiniature = FALSE, maxTags = 100)

Arguments

output

A name of the file in which artifacts should be summarized.

repo

A character containing a name of the Remote repository on which the Repository is stored. By default set to NULL - see Note.

user

A character containing a name of the Github user on whose account the repo is created. By default set to NULL - see Note.

branch

A character containing a name of the Remote Repository's branch on which the Repository is stored. Default branch is master.

subdir

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

repoType

A character containing a type of the remote repository. Currently it can be 'github' or 'bitbucket'.

addTags

Logical, whether to add artfiact's Tags to the output.

addMiniature

Logical, whether to add artfiact's miniature/plots to the output.

maxTags

Integer. The maximal length of chunks output when describing Tags of artifact.

Details

To learn more about artifacts visit archivist-package.

See Also

Markdown example: https://github.com/pbiecek/archivist/issues/144#issuecomment-174192366

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

Examples

## Not run: 
# 
# createMDGallery(user = 'MarcinKosinski', repo = 'Museum',
#  'README_test1.md', addTags = TRUE)
# createMDGallery('graphGallery', 'pbiecek', addMiniature = TRUE,
#  'README_test2.md', addTags = TRUE)
# 
# ## End(Not run)