Reduced package size

1. Deleted inst/extdata/example_images
2. Replaced example_model and example_analysis with docs with writer IDs that contain numbers and letters. Updated all tests accordingly.

Author: stephaniereinders

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: handwriter
 Title: Handwriting Analysis in R
-Version: 3.1.0.9000
+Version: 3.2.0
 Authors@R: c(person("Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in Forensic Evidence", role = c("aut", "cph", "fnd")),
           person("Nick", "Berry", role = "aut"),
           person("Stephanie", "Reinders", role = c("aut", "cre"), email = "srein@iastate.edu"),

NEWS.md

@@ -1,4 +1,9 @@
-# handwriter (development version)
+# handwriter 3.2.0
+
+## Minor improvements and fixes
+
+* The functions `fit_model()` and `analyze_questioned_documents()` now allow writer IDs that contain numbers and letters.
+
 
 # handwriter 3.1.0
 

R/RcppExports.R

@@ -16,13 +16,15 @@ cleanBinaryImage <- function(img) {
 #' getGraphInfo_cpp
 #'
 #' Gather and format the parameter values need to calculate the distance
-#' 
+#' between ' two graphs.
+#'
 #' @param imageList1 A graph
 #' @param imageList2 A graph
 #' @param isProto1 True or false. Is the graph information in prototype format?
 #' @param isProto2 True or false. Is the graph information in prototype format?
 #' @param numPathCuts An integer number of cuts to make when comparing segments
-#' 
+#' of paths ' @return List of formatted parameters
+#'
 #' @noRd
 getGraphInfo_cpp <- function(imageList1, imageList2, isProto1, isProto2, numPathCuts) {
     .Call(`_handwriter_getGraphInfo_cpp`, imageList1, imageList2, isProto1, isProto2, numPathCuts)

R/cluster_templates.R

@@ -44,9 +44,7 @@
 #' @examples
 #' \dontrun{
 #' main_dir <- "path/to/folder"
-#' template_docs <- system.file("extdata/example_images/template_training_images",
-#'   package = "handwriter"
-#' )
+#' template_docs <- "path/to/template_training_docs"
 #' template_list <- make_clustering_template(
 #'   main_dir = main_dir,
 #'   template_docs = template_docs,

R/data.R

@@ -95,17 +95,17 @@
 
 #' Example cluster template
 #'
-#' An example cluster template created from the template training example
-#' handwriting documents included in the package. These documents are located in
-#' `system.file("extdata/example_images/template_training_images", package =
-#' "handwriter")`. The cluster template was created with K=10 clusters and a
-#' small, random sample of 1000 graphs.
+#' An example cluster template created with [`make_clustering_template()`]. The
+#' cluster template was created from handwriting samples
+#' "w0016_s01_pLND_r01.png", "w0080_s01_pLND_r01.png", "w0124_s01_pLND_r01.png",
+#' "w0138_s01_pLND_r01.png", and "w0299_s01_pLND_r01.png" from the CSAFE Handwriting
+#' Database. The template has K=5 clusters.
 #'
 #' @format A list containing a single cluster template created by
-#'   [`make_clustering_template()`]. The cluster template was created by
-#'   sorting a random sample of 1000 graphs from 10 training documents into 10
-#'   clusters with a K-means algorithm. The cluster template is a named list
-#'   with 16 items:
+#'   [`make_clustering_template()`]. The cluster template was created by sorting
+#'   a random sample of 1000 graphs from 10 training documents into 10 clusters
+#'   with a K-means algorithm. The cluster template is a named list with 16
+#'   items:
 #' \describe{
 #' \item{seed}{An integer for the random number generator.}
 #' \item{cluster}{A vector of cluster assignments
@@ -135,7 +135,7 @@
 #' # view cluster fill counts for template training documents
 #' template_data <- format_template_data(example_cluster_template)
 #' plot_cluster_fill_counts(template_data, facet = TRUE)
-#' 
+#'
 #' @md
 "example_cluster_template"
 

README.md

@@ -56,7 +56,7 @@ Use `processDocument()` to
 library(handwriter)
 phrase <- system.file("extdata", "phrase_example.png", package = "handwriter")
 doc <- processDocument(phrase)
-#> path in readPNGBinary: /private/var/folders/1z/jk9bqhdd06j1fxx0_xm2jj980000gn/T/RtmpEwGR3a/temp_libpathb4fe4d792ef7/handwriter/extdata/phrase_example.png
+#> path in readPNGBinary: /private/var/folders/1z/jk9bqhdd06j1fxx0_xm2jj980000gn/T/RtmplsdN6z/temp_libpath947954bb6036/handwriter/extdata/phrase_example.png
 #> Starting Processing...
 #> Getting Nodes...
 #> Skeletonizing writing...
@@ -288,7 +288,7 @@ View a description of a variable with the `about_variable` function.
 
 ``` r
 about_variable(variable = "mu[1,1]", model = model)
-#> [1] "Mu is the location parameter of a wrapped-Cauchy distribution for writer ID 9 and cluster 1"
+#> [1] "Mu is the location parameter of a wrapped-Cauchy distribution for writer ID w0009 and cluster 1"
 ```
 
 View a trace plot of a variable.
@@ -374,10 +374,10 @@ View the posterior probabilities of writership.
 
 ``` r
 analysis$posterior_probabilities
-#>       known_writer w0030_s03_pWOZ_r01
-#> 1   known_writer_9                  0
-#> 2  known_writer_30                  1
-#> 3 known_writer_238                  0
+#>         known_writer w0030_s03_pWOZ_r01
+#> 1 known_writer_w0009                  0
+#> 2 known_writer_w0030                  1
+#> 3 known_writer_w0238                  0
 ```
 
 #### For Research Only

data-raw/example_data.R

@@ -37,7 +37,7 @@ make_example_model <- function(main_dir){
                              num_iters = 200, 
                              num_chains = 1, 
                              num_cores = 5,
-                             writer_indices = c(2, 5), 
+                             writer_indices = c(1, 5), 
                              doc_indices = c(7, 18))
   # save to data folder
   usethis::use_data(example_model, overwrite = TRUE)
@@ -51,7 +51,7 @@ make_example_analyses <- function(main_dir, num_cores = 5) {
                                                    questioned_docs = questioned_docs, 
                                                    model = example_model, 
                                                    num_cores = num_cores,
-                                                   writer_indices = c(2, 5), 
+                                                   writer_indices = c(1, 5), 
                                                    doc_indices = c(7, 18))
 
   usethis::use_data(example_analysis, overwrite = TRUE)