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.
createMDGallery(output, repo = aoptions("repo"), user = aoptions("user"),
branch = aoptions("branch"), subdir = aoptions("subdir"),
repoType = aoptions("repoType"), addTags = FALSE, addMiniature = FALSE,
maxTags = 100)
A name of the file in which artifacts should be summarized.
A character containing a name of the Remote repository on which the Repository is stored.
By default set to NULL
- see Note
.
A character containing a name of the Github user on whose account the repo
is created.
By default set to NULL
- see Note
.
A character containing a name of
the Remote Repository's branch on which the Repository is stored. Default branch
is master
.
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.
A character containing a type of the remote repository. Currently it can be 'github' or 'bitbucket'.
Logical, whether to add artfiact's Tags to the output
.
Logical, whether to add artfiact's miniature/plots
to the output
.
Integer. The maximal length of chunks output when describing Tags
of artifact.
Bug reports and feature requests can be sent to https://github.com/pbiecek/archivist/issues
To learn more about artifacts visit archivist-package.
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
Markdown example: https://github.com/pbiecek/archivist/issues/144#issuecomment-174192366
Other archivist: Repository
,
Tags
, %a%
,
addHooksToPrint
, addTagsRepo
,
aformat
, ahistory
,
alink
, aoptions
,
archivist-package
,
areadLocal
, aread
,
asearchLocal
, asearch
,
asession
, atrace
,
cache
, copyLocalRepo
,
createLocalRepo
,
deleteLocalRepo
,
getRemoteHook
, getTagsLocal
,
loadFromLocalRepo
, md5hash
,
removeTagsRepo
, restoreLibs
,
rmFromLocalRepo
,
saveToLocalRepo
,
searchInLocalRepo
,
setLocalRepo
,
shinySearchInLocalRepo
,
showLocalRepo
,
splitTagsLocal
,
summaryLocalRepo
,
zipLocalRepo
# NOT RUN {
createMDGallery(user = 'MarcinKosinski', repo = 'Museum',
'README_test1.md', addTags = TRUE)
createMDGallery('graphGallery', 'pbiecek', addMiniature = TRUE,
'README_test2.md', addTags = TRUE)
# }
# NOT RUN {
# }
Run the code above in your browser using DataCamp Workspace