Merge pull request #28 from CSAFE-ISU/27-update-installation-instruct…

…ions

Updated instructions in README and website

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,19 +31,23 @@ 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
 
 Open RStudio, navigate to the console window, and type:
 
 ``` r
+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.

README.qmd

@@ -5,14 +5,15 @@ 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
 
 ## View a Demo
 
 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,19 +26,23 @@ 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
 
 Open RStudio, navigate to the console window, and type:
 
 ```{r, eval = FALSE}
+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.

_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, <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},
   }
 ```

_quarto/index.qmd

@@ -5,14 +5,15 @@ 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
 
 ## View a Demo
 
 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,19 +26,23 @@ 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
 
 Open RStudio, navigate to the console window, and type:
 
 ```{r, eval = FALSE}
+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.

docs/CITATION.html

@@ -133,17 +133,16 @@ <h1>Citation</h1>
 <pre class="verbatim"><code>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, &lt;https://CRAN.R-project.org/package=handwriterApp&gt;.
+  Forensic Evidence, Reinders S (????). _handwriterApp: A 'shiny' Application for Handwriting Analysis_. R package
+  version 1.0.1.9000, &lt;https://github.com/CSAFE-ISU/handwriterApp&gt;.
 
 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},
   }</code></pre>
 
 

docs/index.html

@@ -182,7 +182,7 @@ <h1 class="title">Welcome</h1>
 </header>
 
 
-<p>Handwriter is designed to assist forensic examiners by analyzing handwritten documents against a <em>closed set</em> 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.</p>
+<p>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.</p>
 <section id="quick-start" class="level1">
 <h1>Quick Start</h1>
 <section id="view-a-demo" class="level2">
@@ -200,18 +200,22 @@ <h3 class="anchored" data-anchor-id="installation">Installation</h3>
 </ul>
 <p>Install the handwriterApp R package. Open RStudio and navigate to the console window and type</p>
 <div class="cell">
-<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">"handwriterApp"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">options</span>(<span class="at">timeout =</span> <span class="dv">100000</span>)</span>
+<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">"handwriterApp"</span>)</span>
+<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">"devtools"</span>)</span>
+<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">"CSAFE-ISU/handwriterRF"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </div>
 </section>
 <section id="launch-the-app" class="level3">
 <h3 class="anchored" data-anchor-id="launch-the-app">Launch the App</h3>
 <p>Open RStudio, navigate to the console window, and type:</p>
 <div class="cell">
-<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(handwriterApp)</span>
-<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu">handwriterApp</span>()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(handwriterRF)</span>
+<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(handwriterApp)</span>
+<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="fu">handwriterApp</span>()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </div>
 <p>In the pop-up window, click <strong>Open in Browser</strong>. If you use the app in the pop-up window instead of in a browser, some links will not work.</p>
-<p>Click <strong>Use Your Own Samples</strong> and follow the instructions in the app.</p>
+<p>Follow the instructions to analyze handwriting samples.</p>
 
 
 </section>

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."
   }
 ]