From d9831f14887fe26bd65ea020fd361c556cb51f57 Mon Sep 17 00:00:00 2001 From: Stephanie Reinders Date: Wed, 30 Oct 2024 09:47:02 -0500 Subject: [PATCH] Updated instructions in README and website --- README.md | 18 +++++++++++------- README.qmd | 9 +++++++-- _quarto/CITATION.md | 9 ++++----- _quarto/freeze.rds | Bin 208 -> 205 bytes _quarto/index.qmd | 9 +++++++-- docs/CITATION.html | 9 ++++----- docs/freeze.rds | Bin 208 -> 205 bytes docs/index.html | 14 +++++++++----- docs/search.json | 6 +++--- 9 files changed, 45 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 85f6a55..3bda7a6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Welcome -Handwriter is designed to assist forensic examiners by analyzing -handwritten documents against a *closed set* of potential writers. It -determines the probability that each writer wrote the document. Whether -you are a forensic document examiner, legal professional, academic, or -simply curious about how statistics are applied to handwriting, -handwriter provides an automated way to evaluate handwriting samples. +Unlock the power of handwriting analysis with handwriter. This tool is +designed to assist forensic examiners by analyzing handwritten +documents. Whether you are a forensic document examiner, legal +professional, academic, or simply curious about how statistics are +applied to handwriting, handwriter provides an automated way to evaluate +handwriting samples. # Quick Start @@ -31,7 +31,10 @@ Install the handwriterApp R package. Open RStudio and navigate to the console window and type ``` r +options(timeout = 100000) install.packages("handwriterApp") +install.packages("devtools") +devtools::install_github("CSAFE-ISU/handwriterRF") ``` ### Launch the App @@ -39,6 +42,7 @@ install.packages("handwriterApp") Open RStudio, navigate to the console window, and type: ``` r +library(handwriterRF) library(handwriterApp) handwriterApp() ``` @@ -46,4 +50,4 @@ handwriterApp() In the pop-up window, click **Open in Browser**. If you use the app in the pop-up window instead of in a browser, some links will not work. -Click **Use Your Own Samples** and follow the instructions in the app. +Follow the instructions to analyze handwriting samples. diff --git a/README.qmd b/README.qmd index 56a0844..97271f6 100644 --- a/README.qmd +++ b/README.qmd @@ -5,7 +5,7 @@ format: theme: csafe.css --- -Handwriter is designed to assist forensic examiners by analyzing handwritten documents against a *closed set* of potential writers. It determines the probability that each writer wrote the document. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples. +Unlock the power of handwriting analysis with handwriter. This tool is designed to assist forensic examiners by analyzing handwritten documents. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples. # Quick Start @@ -13,6 +13,7 @@ Handwriter is designed to assist forensic examiners by analyzing handwritten doc View a demo of handwriter on handwritten documents from the CSAFE Handwriting Database. Go to [demo](https://csafe.shinyapps.io/handwriterAppDemo/). + ## Use Your Own Handwriting Samples ### Installation @@ -25,7 +26,10 @@ Handwriter requires R, RStudio IDE, and JAGS. Install the handwriterApp R package. Open RStudio and navigate to the console window and type ```{r, eval=FALSE} +options(timeout = 100000) install.packages("handwriterApp") +install.packages("devtools") +devtools::install_github("CSAFE-ISU/handwriterRF") ``` ### Launch the App @@ -33,6 +37,7 @@ install.packages("handwriterApp") Open RStudio, navigate to the console window, and type: ```{r, eval = FALSE} +library(handwriterRF) library(handwriterApp) handwriterApp() ``` @@ -40,4 +45,4 @@ handwriterApp() In the pop-up window, click **Open in Browser**. If you use the app in the pop-up window instead of in a browser, some links will not work. -Click **Use Your Own Samples** and follow the instructions in the app. \ No newline at end of file +Follow the instructions to analyze handwriting samples. diff --git a/_quarto/CITATION.md b/_quarto/CITATION.md index c496b91..b3eb498 100644 --- a/_quarto/CITATION.md +++ b/_quarto/CITATION.md @@ -4,16 +4,15 @@ To cite package ‘handwriterApp’ in publications use: Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in - Forensic Evidence, Reinders S (2024). _handwriterApp: A 'shiny' Application for Handwriting Analysis_. R package - version 1.0.1, . + Forensic Evidence, Reinders S (????). _handwriterApp: A 'shiny' Application for Handwriting Analysis_. R package + version 1.0.1.9000, . A BibTeX entry for LaTeX users is @Manual{, title = {handwriterApp: A 'shiny' Application for Handwriting Analysis}, author = {{Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in Forensic Evidence} and Stephanie Reinders}, - year = {2024}, - note = {R package version 1.0.1}, - url = {https://CRAN.R-project.org/package=handwriterApp}, + note = {R package version 1.0.1.9000}, + url = {https://github.com/CSAFE-ISU/handwriterApp}, } ``` diff --git a/_quarto/freeze.rds b/_quarto/freeze.rds index 36a1761b307c8e306d327febbddf24b75a4f29ea..90e9f8315e202f3ed01bb30bbdfccec56d04a1ae 100644 GIT binary patch literal 205 zcmV;;05bm{iwFP!0000015J**3c^4TMMq5vtwj6)e?Z+yvX7L4+K7!P*iLq5Q7|FK zfPXKp_`qVgmwQez#{mHJAc{KBi$jI@uwPFNKzH~C&<{CDa<33IF?ySrG)s{)AEGec zIBCq!6PC~>ETkmmJcdh)ypURH=Y+$rrwZjsDI_K=j7zHKC#u}NIk(&_>Uy^OveApRT-FzAd6S730eCzChdH_> H00961p?X@r literal 208 zcmV;>05AU^iwFP!0000015J*>io!4uhDX~T){}@2urIJ~5}QeS6jm?dr6_ovBoh>D zscylymyN6i4?puW-*@0RRB+wqD@? diff --git a/_quarto/index.qmd b/_quarto/index.qmd index 56a0844..97271f6 100644 --- a/_quarto/index.qmd +++ b/_quarto/index.qmd @@ -5,7 +5,7 @@ format: theme: csafe.css --- -Handwriter is designed to assist forensic examiners by analyzing handwritten documents against a *closed set* of potential writers. It determines the probability that each writer wrote the document. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples. +Unlock the power of handwriting analysis with handwriter. This tool is designed to assist forensic examiners by analyzing handwritten documents. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples. # Quick Start @@ -13,6 +13,7 @@ Handwriter is designed to assist forensic examiners by analyzing handwritten doc View a demo of handwriter on handwritten documents from the CSAFE Handwriting Database. Go to [demo](https://csafe.shinyapps.io/handwriterAppDemo/). + ## Use Your Own Handwriting Samples ### Installation @@ -25,7 +26,10 @@ Handwriter requires R, RStudio IDE, and JAGS. Install the handwriterApp R package. Open RStudio and navigate to the console window and type ```{r, eval=FALSE} +options(timeout = 100000) install.packages("handwriterApp") +install.packages("devtools") +devtools::install_github("CSAFE-ISU/handwriterRF") ``` ### Launch the App @@ -33,6 +37,7 @@ install.packages("handwriterApp") Open RStudio, navigate to the console window, and type: ```{r, eval = FALSE} +library(handwriterRF) library(handwriterApp) handwriterApp() ``` @@ -40,4 +45,4 @@ handwriterApp() In the pop-up window, click **Open in Browser**. If you use the app in the pop-up window instead of in a browser, some links will not work. -Click **Use Your Own Samples** and follow the instructions in the app. \ No newline at end of file +Follow the instructions to analyze handwriting samples. diff --git a/docs/CITATION.html b/docs/CITATION.html index a5f4870..92264a2 100644 --- a/docs/CITATION.html +++ b/docs/CITATION.html @@ -133,17 +133,16 @@

Citation

To cite package ‘handwriterApp’ in publications use:
 
   Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in
-  Forensic Evidence, Reinders S (2024). _handwriterApp: A 'shiny' Application for Handwriting Analysis_. R package
-  version 1.0.1, <https://CRAN.R-project.org/package=handwriterApp>.
+  Forensic Evidence, Reinders S (????). _handwriterApp: A 'shiny' Application for Handwriting Analysis_. R package
+  version 1.0.1.9000, <https://github.com/CSAFE-ISU/handwriterApp>.
 
 A BibTeX entry for LaTeX users is
 
   @Manual{,
     title = {handwriterApp: A 'shiny' Application for Handwriting Analysis},
     author = {{Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in Forensic Evidence} and Stephanie Reinders},
-    year = {2024},
-    note = {R package version 1.0.1},
-    url = {https://CRAN.R-project.org/package=handwriterApp},
+    note = {R package version 1.0.1.9000},
+    url = {https://github.com/CSAFE-ISU/handwriterApp},
   }
diff --git a/docs/freeze.rds b/docs/freeze.rds index 36a1761b307c8e306d327febbddf24b75a4f29ea..90e9f8315e202f3ed01bb30bbdfccec56d04a1ae 100644 GIT binary patch literal 205 zcmV;;05bm{iwFP!0000015J**3c^4TMMq5vtwj6)e?Z+yvX7L4+K7!P*iLq5Q7|FK zfPXKp_`qVgmwQez#{mHJAc{KBi$jI@uwPFNKzH~C&<{CDa<33IF?ySrG)s{)AEGec zIBCq!6PC~>ETkmmJcdh)ypURH=Y+$rrwZjsDI_K=j7zHKC#u}NIk(&_>Uy^OveApRT-FzAd6S730eCzChdH_> H00961p?X@r literal 208 zcmV;>05AU^iwFP!0000015J*>io!4uhDX~T){}@2urIJ~5}QeS6jm?dr6_ovBoh>D zscylymyN6i4?puW-*@0RRB+wqD@? diff --git a/docs/index.html b/docs/index.html index 3337187..f90be9d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -182,7 +182,7 @@

Welcome

-

Handwriter is designed to assist forensic examiners by analyzing handwritten documents against a closed set of potential writers. It determines the probability that each writer wrote the document. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples.

+

Unlock the power of handwriting analysis with handwriter. This tool is designed to assist forensic examiners by analyzing handwritten documents. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples.

Quick Start

@@ -200,18 +200,22 @@

Installation

Install the handwriterApp R package. Open RStudio and navigate to the console window and type

-
install.packages("handwriterApp")
+
options(timeout = 100000)
+install.packages("handwriterApp")
+install.packages("devtools")
+devtools::install_github("CSAFE-ISU/handwriterRF")

Launch the App

Open RStudio, navigate to the console window, and type:

-
library(handwriterApp)
-handwriterApp()
+
library(handwriterRF)
+library(handwriterApp)
+handwriterApp()

In the pop-up window, click Open in Browser. If you use the app in the pop-up window instead of in a browser, some links will not work.

-

Click Use Your Own Samples and follow the instructions in the app.

+

Follow the instructions to analyze handwriting samples.

diff --git a/docs/search.json b/docs/search.json index cef8d68..2d2611c 100644 --- a/docs/search.json +++ b/docs/search.json @@ -4,7 +4,7 @@ "href": "CITATION.html", "title": "Citation", "section": "", - "text": "Citation\nTo cite package ‘handwriterApp’ in publications use:\n\n Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in\n Forensic Evidence, Reinders S (2024). _handwriterApp: A 'shiny' Application for Handwriting Analysis_. R package\n version 1.0.1, <https://CRAN.R-project.org/package=handwriterApp>.\n\nA BibTeX entry for LaTeX users is\n\n @Manual{,\n title = {handwriterApp: A 'shiny' Application for Handwriting Analysis},\n author = {{Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in Forensic Evidence} and Stephanie Reinders},\n year = {2024},\n note = {R package version 1.0.1},\n url = {https://CRAN.R-project.org/package=handwriterApp},\n }" + "text": "Citation\nTo cite package ‘handwriterApp’ in publications use:\n\n Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in\n Forensic Evidence, Reinders S (????). _handwriterApp: A 'shiny' Application for Handwriting Analysis_. R package\n version 1.0.1.9000, <https://github.com/CSAFE-ISU/handwriterApp>.\n\nA BibTeX entry for LaTeX users is\n\n @Manual{,\n title = {handwriterApp: A 'shiny' Application for Handwriting Analysis},\n author = {{Iowa State University of Science and Technology on behalf of its Center for Statistics and Applications in Forensic Evidence} and Stephanie Reinders},\n note = {R package version 1.0.1.9000},\n url = {https://github.com/CSAFE-ISU/handwriterApp},\n }" }, { "objectID": "NEWS.html", @@ -74,7 +74,7 @@ "href": "index.html", "title": "Welcome", "section": "", - "text": "Handwriter is designed to assist forensic examiners by analyzing handwritten documents against a closed set of potential writers. It determines the probability that each writer wrote the document. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples." + "text": "Unlock the power of handwriting analysis with handwriter. This tool is designed to assist forensic examiners by analyzing handwritten documents. Whether you are a forensic document examiner, legal professional, academic, or simply curious about how statistics are applied to handwriting, handwriter provides an automated way to evaluate handwriting samples." }, { "objectID": "index.html#view-a-demo", @@ -88,6 +88,6 @@ "href": "index.html#use-your-own-handwriting-samples", "title": "Welcome", "section": "Use Your Own Handwriting Samples", - "text": "Use Your Own Handwriting Samples\n\nInstallation\nHandwriter requires R, RStudio IDE, and JAGS.\n\nInstall R and RStudio from POSIT\nInstall JAGS from SourceForge\n\nInstall the handwriterApp R package. Open RStudio and navigate to the console window and type\n\ninstall.packages(\"handwriterApp\")\n\n\n\nLaunch the App\nOpen RStudio, navigate to the console window, and type:\n\nlibrary(handwriterApp)\nhandwriterApp()\n\nIn the pop-up window, click Open in Browser. If you use the app in the pop-up window instead of in a browser, some links will not work.\nClick Use Your Own Samples and follow the instructions in the app." + "text": "Use Your Own Handwriting Samples\n\nInstallation\nHandwriter requires R, RStudio IDE, and JAGS.\n\nInstall R and RStudio from POSIT\nInstall JAGS from SourceForge\n\nInstall the handwriterApp R package. Open RStudio and navigate to the console window and type\n\noptions(timeout = 100000)\ninstall.packages(\"handwriterApp\")\ninstall.packages(\"devtools\")\ndevtools::install_github(\"CSAFE-ISU/handwriterRF\")\n\n\n\nLaunch the App\nOpen RStudio, navigate to the console window, and type:\n\nlibrary(handwriterRF)\nlibrary(handwriterApp)\nhandwriterApp()\n\nIn the pop-up window, click Open in Browser. If you use the app in the pop-up window instead of in a browser, some links will not work.\nFollow the instructions to analyze handwriting samples." } ] \ No newline at end of file