From a89bebfa02b84d370e03392bcb34685c9fd2ea3c Mon Sep 17 00:00:00 2001 From: Ludvig Date: Tue, 16 Jan 2024 16:10:58 +0100 Subject: [PATCH 1/5] Updates roxygen info --- DESCRIPTION | 2 +- R/package_info.R | 4 +--- man/{groupdata2.Rd => groupdata2-package.Rd} | 11 ++++++++++- 3 files changed, 12 insertions(+), 5 deletions(-) rename man/{groupdata2.Rd => groupdata2-package.Rd} (91%) diff --git a/DESCRIPTION b/DESCRIPTION index 69fc561..ab81ffb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -30,7 +30,7 @@ Imports: tibble (>= 2.1.3), tidyr, utils -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.0 Suggests: broom, covr, diff --git a/R/package_info.R b/R/package_info.R index 9022c5d..f69c409 100644 --- a/R/package_info.R +++ b/R/package_info.R @@ -65,9 +65,7 @@ #' #' Go to \code{\link{balance}()} #' @author Ludvig Renbo Olsen, \email{r-pkgs@@ludvigolsen.dk} -#' @docType package -#' @name groupdata2 -NULL +"_PACKAGE" diff --git a/man/groupdata2.Rd b/man/groupdata2-package.Rd similarity index 91% rename from man/groupdata2.Rd rename to man/groupdata2-package.Rd index 0a02c6d..b6ca75e 100644 --- a/man/groupdata2.Rd +++ b/man/groupdata2-package.Rd @@ -1,8 +1,9 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/package_info.R \docType{package} -\name{groupdata2} +\name{groupdata2-package} \alias{groupdata2} +\alias{groupdata2-package} \title{groupdata2: A package for creating groups from data} \description{ Methods for dividing data into groups. @@ -83,6 +84,14 @@ ID level. Go to \code{\link{balance}()} } +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/ludvigolsen/groupdata2} + \item Report bugs at \url{https://github.com/ludvigolsen/groupdata2/issues} +} + +} \author{ Ludvig Renbo Olsen, \email{r-pkgs@ludvigolsen.dk} } From ffeb49f1d65cb67e9a54780ab6712c9c6c682bcd Mon Sep 17 00:00:00 2001 From: Ludvig Date: Tue, 16 Jan 2024 16:11:46 +0100 Subject: [PATCH 2/5] news --- NEWS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/NEWS.md b/NEWS.md index 35153c2..a58f713 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,8 @@ # groupdata2 2.0.3.9000 +* Updates roxygen2 information. + # groupdata2 2.0.3 * Fixes some warnings. From e629570d6a78e90aa46bcdd64d0f8bdec9b39042 Mon Sep 17 00:00:00 2001 From: Ludvig Date: Wed, 28 Feb 2024 12:53:56 +0100 Subject: [PATCH 3/5] Documentation --- DESCRIPTION | 2 +- NEWS.md | 2 +- R/table_of_content_markdown.R | 9 ++------- README.Rmd | 4 ++-- man/all_groups_identical.Rd | 4 ++-- man/collapse_groups.Rd | 2 +- man/collapse_groups_by.Rd | 2 +- man/differs_from_previous.Rd | 4 ++-- man/find_missing_starts.Rd | 4 ++-- man/find_starts.Rd | 4 ++-- man/fold.Rd | 4 ++-- man/grapes-primes-grapes.Rd | 4 ++-- man/grapes-staircase-grapes.Rd | 4 ++-- man/group.Rd | 2 +- man/group_factor.Rd | 2 +- man/partition.Rd | 4 ++-- man/render_toc.Rd | 10 ++-------- man/splt.Rd | 4 ++-- 18 files changed, 30 insertions(+), 41 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index ab81ffb..1b4a3e3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -30,7 +30,7 @@ Imports: tibble (>= 2.1.3), tidyr, utils -RoxygenNote: 7.3.0 +RoxygenNote: 7.3.1 Suggests: broom, covr, diff --git a/NEWS.md b/NEWS.md index a58f713..4ff4e56 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,7 @@ # groupdata2 2.0.3.9000 -* Updates roxygen2 information. +* Updates documentation. # groupdata2 2.0.3 diff --git a/R/table_of_content_markdown.R b/R/table_of_content_markdown.R index 66155d7..dd45f76 100644 --- a/R/table_of_content_markdown.R +++ b/R/table_of_content_markdown.R @@ -14,13 +14,8 @@ #' set to `NULL` for it to be included. #' #' @section Usage: -#' Just drop in a chunk where you want the toc to appear (set `echo=FALSE`): -#' -#' # Table of Contents -#' -#' ```{r echo=FALSE} -#' render_toc("/path/to/the/file.Rmd") -#' ``` +#' Just drop in a \strong{chunk} where you want the toc to appear (set `echo=FALSE`): +#' \code{render_toc("/path/to/the/file.Rmd")} #' @keywords internal #' @param filename Name of RMarkdown or Markdown document #' @param toc_header_name The table of contents header name. If specified, any diff --git a/README.Rmd b/README.Rmd index 2b97996..9c98253 100644 --- a/README.Rmd +++ b/README.Rmd @@ -32,8 +32,8 @@ rvers <- substring(dep, 7, nchar(dep)-1) # groupdata2 -**Author:** [Ludvig R. Olsen](http://ludvigolsen.dk/) ( r-pkgs@ludvigolsen.dk )
-**License:** [MIT](https://opensource.org/license/mit/)
+**Author:** [Ludvig R. Olsen](https://www.ludvigolsen.dk/) ( r-pkgs@ludvigolsen.dk )
+**License:** [MIT](https://opensource.org/license/mit)
**Started:** October 2016 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/groupdata2)](https://cran.r-project.org/package=groupdata2) diff --git a/man/all_groups_identical.Rd b/man/all_groups_identical.Rd index bf786e8..32e7823 100644 --- a/man/all_groups_identical.Rd +++ b/man/all_groups_identical.Rd @@ -56,11 +56,11 @@ all_groups_identical(x1, x2) # FALSE } \seealso{ Other grouping functions: -\code{\link{collapse_groups_by}}, \code{\link{collapse_groups}()}, +\code{\link{collapse_groups_by}}, \code{\link{fold}()}, -\code{\link{group_factor}()}, \code{\link{group}()}, +\code{\link{group_factor}()}, \code{\link{partition}()}, \code{\link{splt}()} } diff --git a/man/collapse_groups.Rd b/man/collapse_groups.Rd index 0760d7e..3fbed54 100644 --- a/man/collapse_groups.Rd +++ b/man/collapse_groups.Rd @@ -638,8 +638,8 @@ Other grouping functions: \code{\link{all_groups_identical}()}, \code{\link{collapse_groups_by}}, \code{\link{fold}()}, -\code{\link{group_factor}()}, \code{\link{group}()}, +\code{\link{group_factor}()}, \code{\link{partition}()}, \code{\link{splt}()} } diff --git a/man/collapse_groups_by.Rd b/man/collapse_groups_by.Rd index 7959c4f..bdcdcaa 100644 --- a/man/collapse_groups_by.Rd +++ b/man/collapse_groups_by.Rd @@ -353,8 +353,8 @@ Other grouping functions: \code{\link{all_groups_identical}()}, \code{\link{collapse_groups}()}, \code{\link{fold}()}, -\code{\link{group_factor}()}, \code{\link{group}()}, +\code{\link{group_factor}()}, \code{\link{partition}()}, \code{\link{splt}()} } diff --git a/man/differs_from_previous.Rd b/man/differs_from_previous.Rd index 77f295a..7986773 100644 --- a/man/differs_from_previous.Rd +++ b/man/differs_from_previous.Rd @@ -152,8 +152,8 @@ differs_from_previous(df, col = "n", threshold = c(-4, 2), direction = "both") Other l_starts tools: \code{\link{find_missing_starts}()}, \code{\link{find_starts}()}, -\code{\link{group_factor}()}, -\code{\link{group}()} +\code{\link{group}()}, +\code{\link{group_factor}()} } \author{ Ludvig Renbo Olsen, \email{r-pkgs@ludvigolsen.dk} diff --git a/man/find_missing_starts.Rd b/man/find_missing_starts.Rd index b63ef3c..e19de29 100644 --- a/man/find_missing_starts.Rd +++ b/man/find_missing_starts.Rd @@ -71,8 +71,8 @@ find_missing_starts(df, starts, Other l_starts tools: \code{\link{differs_from_previous}()}, \code{\link{find_starts}()}, -\code{\link{group_factor}()}, -\code{\link{group}()} +\code{\link{group}()}, +\code{\link{group_factor}()} } \author{ Ludvig Renbo Olsen, \email{r-pkgs@ludvigolsen.dk} diff --git a/man/find_starts.Rd b/man/find_starts.Rd index 6c7162e..5066341 100644 --- a/man/find_starts.Rd +++ b/man/find_starts.Rd @@ -119,8 +119,8 @@ group(df, Other l_starts tools: \code{\link{differs_from_previous}()}, \code{\link{find_missing_starts}()}, -\code{\link{group_factor}()}, -\code{\link{group}()} +\code{\link{group}()}, +\code{\link{group_factor}()} } \author{ Ludvig Renbo Olsen, \email{r-pkgs@ludvigolsen.dk} diff --git a/man/fold.Rd b/man/fold.Rd index 8ce990d..c80e6eb 100644 --- a/man/fold.Rd +++ b/man/fold.Rd @@ -434,10 +434,10 @@ df_folded_1 \%>\% Other grouping functions: \code{\link{all_groups_identical}()}, -\code{\link{collapse_groups_by}}, \code{\link{collapse_groups}()}, -\code{\link{group_factor}()}, +\code{\link{collapse_groups_by}}, \code{\link{group}()}, +\code{\link{group_factor}()}, \code{\link{partition}()}, \code{\link{splt}()} } diff --git a/man/grapes-primes-grapes.Rd b/man/grapes-primes-grapes.Rd index feb1f49..d378089 100644 --- a/man/grapes-primes-grapes.Rd +++ b/man/grapes-primes-grapes.Rd @@ -33,8 +33,8 @@ library(groupdata2) \seealso{ Other staircase tools: \code{\link{\%staircase\%}()}, -\code{\link{group_factor}()}, -\code{\link{group}()} +\code{\link{group}()}, +\code{\link{group_factor}()} Other remainder tools: \code{\link{\%staircase\%}()} diff --git a/man/grapes-staircase-grapes.Rd b/man/grapes-staircase-grapes.Rd index c273176..cda9339 100644 --- a/man/grapes-staircase-grapes.Rd +++ b/man/grapes-staircase-grapes.Rd @@ -40,8 +40,8 @@ for (step_size in c(1:30)){ \seealso{ Other staircase tools: \code{\link{\%primes\%}()}, -\code{\link{group_factor}()}, -\code{\link{group}()} +\code{\link{group}()}, +\code{\link{group_factor}()} Other remainder tools: \code{\link{\%primes\%}()} diff --git a/man/group.Rd b/man/group.Rd index 48fcc7e..d5c3652 100644 --- a/man/group.Rd +++ b/man/group.Rd @@ -221,8 +221,8 @@ df_grouped <- group( \seealso{ Other grouping functions: \code{\link{all_groups_identical}()}, -\code{\link{collapse_groups_by}}, \code{\link{collapse_groups}()}, +\code{\link{collapse_groups_by}}, \code{\link{fold}()}, \code{\link{group_factor}()}, \code{\link{partition}()}, diff --git a/man/group_factor.Rd b/man/group_factor.Rd index 9ef61c8..2c42de0 100644 --- a/man/group_factor.Rd +++ b/man/group_factor.Rd @@ -207,8 +207,8 @@ df$groups <- groups \seealso{ Other grouping functions: \code{\link{all_groups_identical}()}, -\code{\link{collapse_groups_by}}, \code{\link{collapse_groups}()}, +\code{\link{collapse_groups_by}}, \code{\link{fold}()}, \code{\link{group}()}, \code{\link{partition}()}, diff --git a/man/partition.Rd b/man/partition.Rd index b5f2212..9af5e64 100644 --- a/man/partition.Rd +++ b/man/partition.Rd @@ -241,11 +241,11 @@ partitions_2 \%>\% \seealso{ Other grouping functions: \code{\link{all_groups_identical}()}, -\code{\link{collapse_groups_by}}, \code{\link{collapse_groups}()}, +\code{\link{collapse_groups_by}}, \code{\link{fold}()}, -\code{\link{group_factor}()}, \code{\link{group}()}, +\code{\link{group_factor}()}, \code{\link{splt}()} } \author{ diff --git a/man/render_toc.Rd b/man/render_toc.Rd index 8a8cdd6..d149df0 100644 --- a/man/render_toc.Rd +++ b/man/render_toc.Rd @@ -41,14 +41,8 @@ set to \code{NULL} for it to be included. } \section{Usage}{ -Just drop in a chunk where you want the toc to appear (set \code{echo=FALSE}): - -\if{html}{\out{
}}\preformatted{# Table of Contents - -```\{r echo=FALSE\} -render_toc("/path/to/the/file.Rmd") -``` -}\if{html}{\out{
}} +Just drop in a \strong{chunk} where you want the toc to appear (set \code{echo=FALSE}): +\code{render_toc("/path/to/the/file.Rmd")} } \keyword{internal} diff --git a/man/splt.Rd b/man/splt.Rd index f739930..6fa7aea 100644 --- a/man/splt.Rd +++ b/man/splt.Rd @@ -169,11 +169,11 @@ df_list <- splt(df, 5, method = "n_dist") \seealso{ Other grouping functions: \code{\link{all_groups_identical}()}, -\code{\link{collapse_groups_by}}, \code{\link{collapse_groups}()}, +\code{\link{collapse_groups_by}}, \code{\link{fold}()}, -\code{\link{group_factor}()}, \code{\link{group}()}, +\code{\link{group_factor}()}, \code{\link{partition}()} } \author{ From 34dacee7680071b686d1c5db66a79de51cf1094a Mon Sep 17 00:00:00 2001 From: Ludvig Date: Tue, 5 Mar 2024 11:36:27 +0100 Subject: [PATCH 4/5] Reknits readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aaf123d..1517ce9 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ # groupdata2 -**Author:** [Ludvig R. Olsen](http://ludvigolsen.dk/) ( +**Author:** [Ludvig R. Olsen](https://www.ludvigolsen.dk/) ( )
**License:** -[MIT](https://opensource.org/license/mit/)
**Started:** October +[MIT](https://opensource.org/license/mit)
**Started:** October 2016 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/groupdata2)](https://cran.r-project.org/package=groupdata2) From 53fe97dbd5c33dc94af49ece5482fc46897bf7cc Mon Sep 17 00:00:00 2001 From: Ludvig Date: Tue, 5 Mar 2024 11:38:01 +0100 Subject: [PATCH 5/5] Prepares for CRAN --- DESCRIPTION | 2 +- NEWS.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 1b4a3e3..5f464a5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: groupdata2 Title: Creating Groups from Data -Version: 2.0.3.9000 +Version: 2.0.4 Authors@R: person( given = "Ludvig Renbo", family = "Olsen", diff --git a/NEWS.md b/NEWS.md index 4ff4e56..7244716 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,5 @@ -# groupdata2 2.0.3.9000 +# groupdata2 2.0.4 * Updates documentation.