fixing doucmentationf for and

R/hamming_join_core.R

@@ -54,7 +54,7 @@ hamming_join <- function(a, b, mode, by, n_bands, band_width,
   if (!is.null(similarity_column)) {
     similarities <- hamming_distance(
       pull(a[match_table[, 1], ], by_a),
-      pull(b[match_table[, 2], ], by_b),
+      pull(b[match_table[, 2], ], by_b)
     )
   }
 

R/lsh_properties.R

@@ -173,6 +173,9 @@ jaccard_hyper_grid_search <- function(s1 = .1, s2 = .7, p1 = .001, p2 = .999) {
 #'
 #' @param n_bands The number of LSH bands used in hashing.
 #'
+#' @param imput_length the length (number of characters) of the input strings
+#' you want to calculate.
+#'
 #' @param band_width The number of hashes in each band.
 #'
 #' @return A decimal number giving the probability that the two items will be

R/jaccard_similarity.R → R/string_similarities.R

@@ -30,12 +30,12 @@ jaccard_similarity <- function(a, b, ngram_width = 2) {
 #'
 #' @examples
 #' hamming_distance(
-#'   c("the quick brown fox", "jumped over the lazy dog"),
-#'   c("the quck bron fx", "jumped over hte lazy dog")
+#'   c("ACGTCGATGACGTGATGCGTAGCGTA", "ACGTCGATGTGCTCTCGTCGATCTAC"),
+#'   c("ACGTCGACGACGTGATGCGCAGCGTA", "ACGTCGATGGGGTCTCGTCGATCTAC")
 #' )
 #'
 #' @export
-hamming_distance <- function(a, b, ngram_width = 2) {
+hamming_distance <- function(a, b) {
   stopifnot(length(a) == length(b))
   rust_hamming_distance(a, b)
 }