fixed docs

tanaylab · Jan 8, 2024 · 8f40e52 · 8f40e52
1 parent d2474ca
commit 8f40e52
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 10 deletions.
diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -1,3 +1,3 @@
-Version: 0.3.11
-Date: 2023-08-20 05:36:25 UTC
-SHA: d914bb35363df902b2dab8ec39c0043a72e9da58
+Version: 0.5.1
+Date: 2024-01-08 14:13:49 UTC
+SHA: d2474ca347f97a74894f130a1fc09119e0d84b93
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: tglkmeans
 Title: Efficient Implementation of K-Means++ Algorithm
-Version: 0.5.1
+Version: 0.5.2
 Authors@R: c(
     person("Aviezer", "Lifshitz", , "[email protected]", role = c("aut", "cre")),
     person("Amos", "Tanay", role = "aut"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,7 @@
+# tglkmeans 0.5.2
+
+* Fixed docs. 
+
 # tglkmeans 0.5.1
 
 * Fix: `cluster` slot ids were corrupted when data was a tibble and `id_column` was `TRUE`.

diff --git a/R/downsample.R b/R/downsample.R
@@ -6,9 +6,9 @@
 #'
 #' @param mat An integer matrix to be downsampled. Can be a matrix or sparse matrix (dgCMatrix).
 #' If the matrix contains NAs, the function will run significantly slower. Values that are
-#' not integers will be coerced to integers using {.code floor()}.
+#' not integers will be coerced to integers using \code{floor()}.
 #' @param target_n The target number of samples to downsample to.
-#' @param target_q A target quantile of sums to downsample to. Only one of {.field target_n} or {.field target_q} can be provided.
+#' @param target_q A target quantile of sums to downsample to. Only one of 'target_n' or 'target_q' can be provided.
 #' @param seed The random seed for reproducibility (default is NULL)
 #' @param remove_columns Logical indicating whether to remove columns with small sums (default is FALSE)
 #'

diff --git a/cran-comments.md b/cran-comments.md
@@ -2,8 +2,9 @@
 
 0 errors | 0 warnings | 1 note
 
-* The requirement for GNU make is due to the use of RcppParallel which requires GNU make.
-* This is a unix only package since it is using tgstat which is not available on windows.
+* Fixed documentation problems from previous submission.
+* The requirement for GNU make is due to the use of RcppParallel (which requires GNU make).
+* This is a unix only package since it is using the package tgstat which is not available on windows.
 
 
 
diff --git a/man/downsample_matrix.Rd b/man/downsample_matrix.Rd