Published November 28, 2015
| Version v1.8
Software
Open
archivist: version 1.8 in CRAN
Description
from NEWS:
-
Archivist Integration With GitHub API: new functions:
- It is possible to create new GitHub repository with an empty 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.
- One can now clone GitHub-archivist repo with new cloneGithubRepo function.
- Added manual page to enable easier usage of this integration: ?`archivist-github-integration`.
- New functions splitTagsLocal and splitTagsGithub enabling to split tag column in database into two separate columns: tagKey and tagValue.
-
Bugs fixed:
- 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.
- 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 shouldn`t.
- %a% operator does react on default = TRUE in createEmpyRepo function.
- deleteRoot = TRUE argument of the deleteRepo function works properly and enables removing root directory of the Repository.
- Some changes in rmFromRepo's body:
- 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.
- Artifacts' data is now removed from tag table in backpack.db file when many = TRUE. They were not removed before.
- Artifacts' data files are now removed from gallery folder. They were not removed before.
- Invisible(NULL) is the result of the function evaluation.
- Some changes in copy*Repo's body:
- Invisible(NULL) is the result of the function evaluation
- repoFrom parameter in copyLocalRepo is set to NULL as default.
- copyFromLocalRepo and copyFromGithubRepo copies only distinct records for table tag and artifact in backpack.db file, that can be seen with show*Repo and copies all mentioned artifacts for local version.
- downloadDB in createEmptyRepo function gives a user-friendly error.
- In zipGithubRepo unzipped file has the same name as zip file. Earlier it had a name of the temporary file that was difficult to notice.
- In setGithubRepo it is now possible to use repoDirGit parameter. Before there was wrong stopifnot condition.
- 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.
- Two crucial parts of checkDirectory's function body were removed due to changes in point 11. checkDirectory2 was completely removed as it is unnecessary now.
- Small change in test_base_functionalities.R due to changes in point 11 and 12.
- aoptions for user and repo will work properly with showGithubRepo and 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.
-
New features:
- print.ahistory function can now print outputs of the artifact's history as the knitr::kable would.
- 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).
- Additional examples to better understand usage of archivist package functions:
- in loadFromRepo function - Loading artifacts from the repository which is built in the archivist package and saving them on the example repository.
- in createEmptyRepo function - creating a default local Repository in non existing directory.
- in rmFromRepo function - removing artifacts with many = TRUE argument.
- in deleteRepo function - using deleteRoot = TRUE argument.
- in copy*Repo function - using graphGallery local repository in copyLocalRepo function.
- in get*Tags function - additional example using getTagsLocal function.
- in aoptions function - added two new examples concerning usage of silent and repoDir parameters in this function.
- 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.
- Adding missing functions which are used in the archivist package now to ?Repository documentation page.
- 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.
- New tests for the following functions: zip*Repo.
- In order to obtain cohesion with Tags in all functions there has been stated such an order:
- 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.
- If we use tags in function's body, as parameters, as R object's atrributes, then they begin with small letter.
- 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
Files
archivist-v1.8.zip
Files
(8.5 MB)
Name | Size | Download all |
---|---|---|
md5:cdd4d96cca07d46931bb0f2e5961d389
|
8.5 MB | Preview Download |
Additional details
Related works
- Is supplement to
- https://github.com/pbiecek/archivist/tree/v1.8 (URL)