saveToLocalRepo
function saves desired artifacts to the local Repository in a given directory.
Artifacts are saved in the local Repository, which is a SQLite database named backpack
.
After every saveToLocalRepo
call the database is refreshed, so the artifact is available
immediately in the database for other collaborators.
Each artifact is archived in a md5hash.rda
file. This file will be saved in a folder
(under repoDir
directory) named gallery
. For each artifact, md5hash
is a
unique string of length 32 that is produced by
digest function, which uses a cryptographical MD5 hash algorithm.
By default, a miniature of an artifact and (if possible) a data set needed to compute this artifact are extracted.
They are also going to be saved in a file named by their md5hash
in the gallery
folder
that exists in the directory specified in the repoDir
argument. Moreover, a specific Tag
-relation
is going to be added to the backpack
dataset in case there is a need to load
the artifact with it's related data set - see loadFromLocalRepo or loadFromRemoteRepo. Default settings
may be changed by using the archiveData
, archiveTag
or archiveMiniature
arguments with the
FALSE
value.
Tags
are artifact's attributes, different for various artifact's classes. For more detailed
information check Tags
Archived artifact can be searched in the backpack
dataset by using the
searchInLocalRepo or searchInRemoteRepo functions. Artifacts can be searched by their Tags,
names
, classes
or archiving date
.
firstRows
parameter.
If the artifact is of class data.frame
or user set archiveData = TRUE
for artifact that stores data within it,
it is possible to specify
how many rows of that data (or that data.frame
) should be archived in a miniature
.
This can be done by adding the argument firstRows
with the
n corresponding to the number of rows (as in head).
Note that, the data can be extracted only from the artifacts that are supported by
the archivist package; see Tags.
Graphical parameters.
If the artifact is of class lattice
or ggplot
, and
archiveMiniature = TRUE
, then it is
possible to set the miniature's width
and height
parameters. By default they are set to
width = 800
, height = 600
.
Supported artifact's classes are listed here Tags.