Skip to content

Commit

Permalink
Added changes to NEWS.md and superseded calculate_slr()
Browse files Browse the repository at this point in the history
  • Loading branch information
stephaniereinders committed Dec 4, 2024
1 parent 28e4a6a commit 7ff3941
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 92 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Depends:
R (>= 2.10)
Imports:
dplyr,
handwriter,
handwriter (>= 3.2.3),
magrittr,
purrr,
ranger,
Expand Down
8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# handwriterRF (development version)

## Major changes

* Created `compare_documents()` to compare two handwritten documents using either a similarity score or a score-based likelihood ratio as a comparison method.

* Created new data frames of writer profiles `train`, `validation`, and `test`. Created a new `random_forest` from `train`. Created `ref_scores`, a list of same writer and different writer similarity scores, from `validation`.

## Minor improvements and bug fixes

* `calculate_slr()` has been superseded in favor of `compare_documents()`, which includes the functionality of `caclulate_slr()` and offers additional functionality.

* Created `plot_scores()` to plot histograms of the reference same writer and different writer similarity scores in `random_forest$scores`.

# handwriterRF 1.0.2
Expand Down
7 changes: 5 additions & 2 deletions R/slrs.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@

#' Calculate a Score-Based Likelihood Ratio
#'
#' Compares two handwriting samples scanned and saved a PNG images with the
#' following steps:
#' `r lifecycle::badge("superseded")` `calculate_slr` has been superseded in
#' favor of `compare_documents()` which offers more functionality.
#'
#' Compares two handwriting
#' samples scanned and saved a PNG images with the following steps:
#' \enumerate{
#' \item \code{\link[handwriter]{processDocument}} splits the writing in both samples into component shapes, or graphs.
#' \item \code{\link[handwriter]{get_clusters_batch}} groups the graphs into clusters of similar shapes.
Expand Down
8 changes: 6 additions & 2 deletions man/calculate_slr.Rd

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

2 changes: 0 additions & 2 deletions vignettes/.gitignore

This file was deleted.

85 changes: 0 additions & 85 deletions vignettes/handwriterRF.Rmd

This file was deleted.

0 comments on commit 7ff3941

Please sign in to comment.