asearchLocal()
. Now repo
is passed correctly to loadFromLocalRepo
(#333).https://raw.githubusercontent.com
is closed, this is why we need to update hooks to https://raw.githack.com
(#332).cache()
function due to (#327). Effect of the bytecompiler needs further research.saveToLocalRepo()
and saveToRepo()
have now additional parameter use_flocks
. If set up to TRUE
then flock
package is use to synchronize access to database (#322).asearchLocal()
and areadLocal()
that work as asearch()
and aread()
for selected local repositories (#298).force
has now different meaning in createLocalRepo()
. As suggested in (#319) and (#318) if forces to override existing backpack.db file.adigest()
allows to use different hash functions (#323)dbExecute()
is used instead of dbGetQuery()
as is recommended in latest version of DBI
package (#316).removeTagsRepo()
is added. It allows to remove specific tags from specific objects. Note that you cannot specify tags via regular expressions (to avoid some accidental deletes). You can always use getLocalTags()
to get list of available tags.createPostgresRepo()
and setPostgresRepo()
. Note, that it's still an experimental feature.default=FALSE
parameter. [#291]aread
and asearch
examples due to new version of ggplot2 - 2.2.0 [#296]asave
examples due to new version of ggplot2 - 2.2.0 [#300]aread()
, asearch()
, searchInLocalRepo()
and loadFromLocalRepo()
are now handling URL addresses as well. This may be useful to access artifacts generated by the shiny app.%a%
archives proper names of first object so does ahistory
prints proper name of archived artifact instead of env[[nm]]
. [#269]addHooksToPrint()
:latex
format as it has new format
argument. [#270]atrace()
function is added. It call trace()
function to store a selected object in the repository after each call to specified FUN (for example 'lm').restoreLibs()
can now restore libraries in custom directory. [#251createMDGallery
has new maxTags
parameter so that gallery's summaries in the README.md
files now has limited chunk's length. [#249]restoreLibs()
function is added. It recovers previous versions of R packages. Needed due to rapid changes in structure of ggplot2
objects. Now one can restore version of the ggplot2
package consistent with archived object.RemoteRepoCheck
is used to verify if parameters for remote repo are correct.asession
returns session info for given artifact (similar to aread).aformat
returns vector of formats in which the artifact is saved (similar to aread).saveToRepo
by default saves session info.repoDirGit
has changed name to subdir
and the default value is now '/'.repoType
parameter).alink
is now working with github and bitbucket repositories.asearch
returns named list of artifacts. MD5hashes are used as names.silent=TRUE
by default in saveToRepo
. Less warnings.saveToRepo
has now two copies, consistent with other names saveToLocalRepo
an short one asave
.archive
, cloneGitHubRepo
, createGitHubRepo
, (deleteGithubRepo
) deleteGitHubRepo
, (pushRepo
) pushGitHubRepo
, (pullRepo
) pullGitHubRepo
have been moved to separate archivist.github
package to maintain Local/Remote consistency. [#198].
1. For the above reason deleteRepo
was deprecated. Use deleteLocalRepo
2. For the above reason createEmptyLocalRepo
and createEmptyRepo
were deprecated. Use createLocalRepo
.
3. For the above reason rmFromRepo
was deprecated. Use rmFromLocalRepo
multiSearchInLocalRepo
and it's remote version were deprecated. Now multiple patterns are available in searchInLocalRepo
/searchInRemoteRepo
.New functions:
alink
function: Returns a Link To Download an Artifact Stored on GitHub Repository. Ideal combination with archive
pushRepo
function which add files, commits them and pushes from Local Repository
to synchronized GitHub one. [#146].pullRepo
pulls (git pull
) changes from remote GitHub Repository
to the corresponding Local one. [#146].deleteLocalRepo
(previous deleteRepo
) and deleteGithubRepo
. [#156].createGithubMDGallery
that give the markdown summary for each artifact in the repository. Ideal for README.md file. Example [#144]Bugs fixed:
asearch
function enables a user to read artifacts from default GitHub repository. In the previous version it was possible only in default local repository.apotions('repo/repoDir', NULL, unset = TRUE)
[#176].New features:
?ahistory
, ?cache
, ?asearch
, ?archive
, ?cloneGithubRepo
, githubFunctions
, ?shinySearchInLocalRepo
, ?alink
documentation pages.asearch
completely new example section divided into 3 subsections: default local repository, default GitHub resository and Github repository.extractTags.lm
, extractTags.htest
. extractTags.lda
, extractTags.qda
, extractTags.survfit
, extractTags.glmnet
, extractTags.partition
.htest
object's data is now saved to repository as a list.devtoolss::session_info()
with an artifact during the execution of saveToRepo()
and archive()
[#184].format:
is now added to every artifact/miniature. Artifacts can be saved in different (and more than one) formats (rda/json/csv) what makes them easier to access from other languages.New and renamed parameters:
user.name
and user.password
parameters of archive
and createEmptyGithubRepo
were changed into user
and password
correspondingly.createEmptyGithubRepo
now can use repoDir
to specify in which directory the synchronized Local Repository should be created [#142].archive
no longer cats hook to the artifact during the execution. Hook cat can be set with new alink
parameter that uses alink()
function, where parameters can be passed with ...
.deleteRepo
has now new unset
parameter that allows to unset global aoptions('repoDir', NULL, unset = TRUE)
when deleted repoDir
was a globally specified Repository [#157].cloneGithubRepo
from local_path
to repoDir
to maintain consistency within package documentation and name convention.createEmptyGithubRepo
, createEmptyRepo(type ='github')
and cloneGithubRepo
now reacts on new default
parameter which sets newly created/cloned repositories (GitHub and synchronized with it Local one) as default [#171 , #142].chain
parameter to value
in saveToRepo
function #101].aformat
parameter to format
in ahistory()
to maintain consistency with alink()
function.alink
. Now the repoDirGit
is supported.archivist
-like Repository
with createEmptyGithubRepo
function. We also added createEmptyLocalRepo
to maintain consistency with other sister functions. createEmptyRepo
is now a wrapper around createEmptyLocalRepo
and createEmptyGithubRepo
functions.
2. One can now clone GitHub-archivist repo with new cloneGithubRepo
function.
3. One can automatically archive artifacts to Local and synchronized GitHub archivist-like Repositories with new archive
function. Example: https://github.com/MarcinKosinski/archive-test4/commits/master
4. Added manual page to enable easier usage of this integration: ``?archivist-github-integration``` (or shorter
?agithub`).splitTagsLocal
and splitTagsGithub
enabling to split tag
column in database into two separate columns: tagKey
and tagValue
.checkDirectory
function is now immune to directories that don't exist. This made
showLocalRepo
function working properly when passed an argument to the directory
that do not exist.
2. Changed dbDisconnect( conn )
call to the on.exit(dbDisconnect( conn ))
in executeSingleQuery
function to prevent a situation in which during an error inside a function (which might be produced), the connection stays open, when it shouldnt. 3.
%a%operator does react on
default = TRUEin
createEmptyRepofunction. 4.
deleteRoot = TRUEargument of the
deleteRepofunction works properly and enables removing root directory of the Repository. 5. Some changes in
rmFromRepo's body: 1. Function will give a warning when a user uses wrong md5hash (that does not exist in the
Repository). In case of wrong md5hash abbreviation a user will receive an error message. 2. Artifacts' data is now removed from tag table in
backpack.dbfile when
many = TRUE. They were not removed before. 3. Artifacts' data files are now removed from
galleryfolder. They were not removed before. 4.
Invisible(NULL)is the result of the function evaluation. 6. Some changes in
copyRepo's body: 1.
Invisible(NULL)is the result of the function evaluation 2.
repoFromparameter in
copyLocalRepois set to
NULLas default. 7.
copyFromLocalRepoand
copyFromGithubRepocopies only distinct records for table
tagand
artifactin
backpack.dbfile, that can be seen with
showRepoand copies all mentioned artifacts for local version. 8.
downloadDBin
createEmptyRepofunction gives a user-friendly error. 9. In
zipGithubRepounzipped file has the same name as zip file. Earlier it had a name of the temporary file that was difficult to notice. 10. In
setGithubRepoit is now possible to use repoDirGit parameter. Before there was wrong
stopifnotcondition. 11.
paste0()was replaced by
file.path()in appropriate places of function's bodies in the following R scripts:
archive.R,
copyToRepo.R,
createEmptyRepo.R,
deleteRepo.R,
extractMiniature.R,
loadFromRepo.R,
rmFromRepo.R,
saveToRepo.R,
zipRepo.R. 12. Two crucial parts of
checkDirectory's function body were removed due to changes in point 11.
checkDirectory2was completely removed as it is unnecessary now. 13. Small change in
test_base_functionalities.Rdue to changes in point 11 and 12. 14.
aoptionsfor
userand
repowill work properly with
showGithubRepoand
summaryGithubRepo` when set. It might have not been noticed in version 1.7, it might have been a bug that occured in the development between 1.7 and 1.8 version.print.ahistory
function can now print outputs of the artifact's history as the knitr::kable
would.
2. Examples for searchInGithubRepo
now works for user='pbiecek'
and repo='archivist
parameters as we added new backpack.db file. The previous one was almost empty (for 7 months).
3. Additional examples to better understand usage of archivist package functions:
1. in loadFromRepo
function - Loading artifacts from the repository which is built in the archivist package and saving them on the example repository.
2. in createEmptyRepo
function - creating a default local Repository in non existing directory.
3. in rmFromRepo
function - removing artifacts with many = TRUE
argument.
4. in deleteRepo
function - using deleteRoot = TRUE
argument.
5. in copy*Repo
function - using graphGallery local repository in copyLocalRepo
function.
6. in get*Tags
function - additional example using getTagsLocal
function.
7. in aoptions
function - added two new examples concerning usage of silent
and repoDir
parameters in this function.
4. Alterations in the text of: ?Tags
, ?Repository
, ?md5hash
, archivist-package
, ?saveToRepo
, loadFromRepo
, summaryRepo
, showRepo
, ?searchInRepo
, ?createEmptyRepo
, ?rmFromRepo
, ?deleteRepo
, copyToRepo
, zipRepo
, setRepo
, getTags
, addTagsRepo
, magrittr
, archivistOptions
, ?aread
documentation pages.
5. Adding missing functions which are used in the archivist package now to ?Repository
documentation page.
6. tempdir()
was replaced by tempfile()
in examples sections of: ?addTagsRepo
, ?cache
, copyToRepo
, createEmptyRepo
, ?deleteRepo
, loadFromRepo
, ?rmFromRepo
, ?saveToRepo
, setRepo
, showRepo
, summaryRepo
, ?Tags
, zipRepo
documentation pages. tempdir
is existing directory in which R works so calling deleteRepo( exampleRepoDir, deleteRoot=TRUE)
removed important R files.
7. New tests for the following functions: zip*Repo
.
8. In order to obtain cohesion with Tags
in all functions there has been stated
such an order:
1. If we use Tags
in the text of function's documentation, examples' comments, then Tags
are considered as a proper name and they begin with capital letter.
2. If we use tags
in function's body, as parameters, as R object's attributes, then they begin with small letter.
9. Added checking if parameters have appropriate lengths in the following function's bodies:
?addTagsRepo
, asearch
, ?cloneGithubRepo
, copy*Repo
, createEmptyLocalRepo
, getTags*
, loadFrom*Repo
, ?rmFromRepo
, ?saveToRepo
, searchIn*Repo
, set*Repo
, ?shinySearchInLocalRepo
, showRepo
, summary*Repo
, zip*Repo
The order of parameters in asearch has changed!
Added graphGallery for self-contained examples
aread allows for single MD5 hash (which will be read from the default repo)
asearch allows for only patterns (will be searched in local repo)
ahistory has now 'artifact' argument instead of 'obj'
Added tests.
Removed unnecessary dependencies - now archivist is free of dependencies.
shiny package is in Suggests so you should load that package before running shinySearchInLocalRepo function.
Moved saveSetToRepo
with a new function loadSetFromRepo
to the github.com/pbiecek/archivist2
repository.
...should be updated...
...should be updated...
setLocalRepo
and setGithubRepo
functions.
...should be updated...