Skip to content

Commit

Permalink
typos and notes identified with win_check
Browse files Browse the repository at this point in the history
  • Loading branch information
pbiecek committed Aug 10, 2024
1 parent e967dff commit 6b71936
Show file tree
Hide file tree
Showing 18 changed files with 55 additions and 41 deletions.
12 changes: 12 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Generated by roxygen2: do not edit by hand

S3method(archivist::extractData,default)
S3method(print,ahistory)
S3method(print,ahistoryKable)
S3method(print,alink)
Expand Down Expand Up @@ -29,6 +30,17 @@ export(createPostgresRepo)
export(deleteLocalRepo)
export(deleteRepo)
export(extractData)
export(extractData.default)
export(extractData.ggplot)
export(extractData.glmnet)
export(extractData.htest)
export(extractData.lda)
export(extractData.lm)
export(extractData.partition)
export(extractData.qda)
export(extractData.survfit)
export(extractData.trellis)
export(extractData.twins)
export(extractMiniature)
export(extractTags)
export(getTagsLocal)
Expand Down
6 changes: 3 additions & 3 deletions R/addArchivistHooks.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
#' \code{addHooksToPrint} adds an overloaded version of the print function for objects of selected class.
#' The overloaded function will add all objects of selected class to the \link{Repository} and then will add hooks (to the Remote or Local Repository)
#' to the HTML report (generated in \pkg{rmarkdown}) for these objects (\code{artifacts} - \link{archivistPackage}).
#' The great example can be seen in this blogpost \href{https://www.r-bloggers.com/2016/02/why-should-you-backup-your-r-objects/}{https://www.r-bloggers.com/2016/02/why-should-you-backup-your-r-objects/}.
#' The great example can be seen in this blogpost.
#'
#' @param class A character with a name of class (one or more) that should be archived.
#' @param repo A character with a name of a Remote repository on which the Repository is archived.
#' If \code{repo = NULL} then hooks will be added to files in local directories.
#' @param user A character with a name of a Remote-repository user on whose account the \code{repo} is created.
#' @param branch A character with a name of Remote-repository's branch on which the Repository is archived.
#' Default \code{branch} is \code{master}.
#' @param subdir A character with a name of a subdirectory on a Remote repository
#' @param subdir A character with a name of a sub directory on a Remote repository
#' on which the Repository is stored. If the Repository is stored in main folder on a Remote repository, this should be set
#' to \code{subdir = "/"} as default.
#' @param repoDir A character containing a name of a Local Repository.
Expand All @@ -27,7 +27,7 @@
#' @template roxlate-contact
#' @note
#' One can specify \code{userTags} as in \link{saveToLocalRepo} for artifacts by adding \code{"tags"} attribute.
#' See note secion about that in \link{saveToLocalRepo}.
#' See note section about that in \link{saveToLocalRepo}.
#'
#' @examples
#'
Expand Down
2 changes: 1 addition & 1 deletion R/ahistory.R
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
#'
#' @section Demonstration:
#'
#' This function is well explained on this \href{https://www.r-bloggers.com/2016/06/r-hero-saves-backup-city-with-archivist-and-github/}{https://www.r-bloggers.com/2016/06/r-hero-saves-backup-city-with-archivist-and-github/} blog post.
#' This function is well explained on this blog post.
#'
#' @examples
#'
Expand Down
24 changes: 13 additions & 11 deletions R/extractData.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@
extractData <- function( object, parrentMd5hash, parentDir, isForce, ASCII )
UseMethod( "extractData" )

#' @exportS3Method archivist::extractData

#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData default
#' @export extractData.default

extractData.default <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){

Expand All @@ -24,7 +26,7 @@ extractData.default <- function( object, parrentMd5hash, parentDir, isForce, ASC
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData ggplot
#' @export extractData.ggplot

extractData.ggplot <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
extractedDF <- object$data
Expand All @@ -46,7 +48,7 @@ extractData.ggplot <- function( object, parrentMd5hash, parentDir, isForce, ASCI
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData lm
#' @export extractData.lm

extractData.lm <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
extractedDF <- object$model
Expand All @@ -68,7 +70,7 @@ extractData.lm <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData htest
#' @export extractData.htest

extractData.htest <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
if (exists(strsplit(object$data.name, " and ")[[1]][1], envir = parent.frame(1)) &
Expand Down Expand Up @@ -100,7 +102,7 @@ extractData.htest <- function( object, parrentMd5hash, parentDir, isForce, ASCII
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData lda
#' @export extractData.lda

extractData.lda <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
if (exists(as.character( ( object$call ) )[3], envir = parent.frame(1) )){
Expand All @@ -127,7 +129,7 @@ extractData.lda <- function( object, parrentMd5hash, parentDir, isForce, ASCII )
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData trellis
#' @export extractData.trellis

extractData.trellis <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
if (exists(as.character( ( object$call ) )[3], envir = parent.frame(1) )){
Expand All @@ -154,7 +156,7 @@ extractData.trellis <- function( object, parrentMd5hash, parentDir, isForce, ASC
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData twins
#' @export extractData.twins

extractData.twins <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
# agnes / diana / mona inherits after twins
Expand All @@ -177,7 +179,7 @@ extractData.twins <- function( object, parrentMd5hash, parentDir, isForce, ASCII
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData partition
#' @export extractData.partition

extractData.partition <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
# pam / clara / fanny inherits after partition
Expand All @@ -200,7 +202,7 @@ extractData.partition <- function( object, parrentMd5hash, parentDir, isForce, A
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData qda
#' @export extractData.qda

extractData.qda <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
if (exists(as.character( ( object$call ) )[2], envir = parent.frame(1) )){
Expand All @@ -227,7 +229,7 @@ extractData.qda <- function( object, parrentMd5hash, parentDir, isForce, ASCII )
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData glmnet
#' @export extractData.glmnet

extractData.glmnet <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
# elmet / lognet / multnet /foshnet /coxnet /mrelnet
Expand Down Expand Up @@ -260,7 +262,7 @@ extractData.glmnet <- function( object, parrentMd5hash, parentDir, isForce, ASCI
#' @return \code{NULL}
#'
#' @rdname extractData
#' @method extractData survfit
#' @export extractData.survfit

extractData.survfit <- function( object, parrentMd5hash, parentDir, isForce, ASCII ){
if (exists(as.character( ( object$call ) )[3], envir = parent.frame(1) )){
Expand Down
4 changes: 2 additions & 2 deletions R/magrittr.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@
#'
#' @section Demonstration:
#'
#' This function is well explained on this \href{https://www.r-bloggers.com/2016/06/r-hero-saves-backup-city-with-archivist-and-github/}{https://www.r-bloggers.com/2016/06/r-hero-saves-backup-city-with-archivist-and-github/} blog post.
#' This function is well explained on this blog post.
#'
#' @examples
#' \dontrun{
#'
#' library("dplyr")
#'
#' ## Usage of %a% operator without setting default repository
#' # We will receive sepcial warning
#' # We will receive special warning
#' iris %a% summary()
#'
#' ## Archiving artifacts with their chaining code
Expand Down
6 changes: 3 additions & 3 deletions man/addHooksToPrint.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aformat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/ahistory.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/alink.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/createMDGallery.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/getRemoteHook.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/loadFromRepo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/magrittr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/removeTagsRepo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/rmFromLocalRepo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/saveToRepo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/setRepo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/splitTags.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6b71936

Please sign in to comment.