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

In archivist: Tools for Storing, Restoring and Searching for R Objects

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 this 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 artifact's Tags to the output.
addMiniature	Logical, whether to add artifact'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 archivistPackage.

Contact

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

Note

If repo and user are set to NULL (as default) in the Remote mode then global parameters set in setRemoteRepo (or via aoptions) function are used.

Author(s)

Marcin Kosinski, [e-mail]

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

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

Other archivist: Repository, Tags, %a%(), addHooksToPrint(), addTagsRepo(), aformat(), ahistory(), alink(), aoptions(), archivistPackage, aread(), areadLocal(), asearch(), asearchLocal(), asession(), atrace(), cache(), copyLocalRepo(), createLocalRepo(), deleteLocalRepo(), getRemoteHook(), getTagsLocal(), loadFromLocalRepo(), md5hash, removeTagsRepo(), 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)

archivist documentation built on Sept. 11, 2024, 8:30 p.m.