Please consider responding to a brief user needs survey.

update readme

parent d155995b
......@@ -44,38 +44,40 @@ Prior to running the model, you must enable content in the files that contain Vi
Failing to complete this step will result in program failure. Files containing Visual Basic for Applications code must be listed as “trusted documents” before any of the code can run. This adds protection for the user by preventing the code from running upon opening a document before the user decides to trust the document. For more information on the enable content warning see Enable Content Warning. To list documents as “trusted documents” complete the following steps:
1) Enable content in the SedimentFingerprinting_R\Manual\InstructionManual.docm file
1) Enable content in the SedimentFingerprinting_R\Manual\InstructionManual.docm file
a. If open, close the InstructionManual.pdf file (it will be updated by the InstructionManual.docm file
a. If open, close the InstructionManual.pdf file (it will be updated by the InstructionManual.docm file
b. Open the SedimentFingerprinting_R\Manual\InstructionManual.docm file
b. Open the SedimentFingerprinting_R\Manual\InstructionManual.docm file
c. Click “Enable Content” in the yellow ribbon on the top of the widow (the file will close itself)
c. Click “Enable Content” in the yellow ribbon on the top of the widow (the file will close itself)
2) Enable content in the Blank.accdb file
2) Enable content in the Blank.accdb file
a. Start by opening the Blank.accdb file. This file contains no information. It acts only as a springboard to send the user back to the core file Sed_SAT.accdb
a. Start by opening the Blank.accdb file. This file contains no information. It acts only as a springboard to send the user back to the core file Sed_SAT.accdb
b. Close the Pop-up window by clicking the “X” in the top right corner
b. Close the Pop-up window by clicking the “X” in the top right corner
c. Click “Enable Content” in the yellow ribbon on the top of the widow (if an error
occurs after enabling content this is due to a missing Visual Basic for Applications reference, see Activating Microsoft Access Visual Basic References below to add required Visual Basic for Applications references)
c. Click “Enable Content” in the yellow ribbon on the top of the widow (if an error
occurs after enabling content this is due to a missing Visual Basic for Applications reference, see Activating Microsoft Access Visual Basic References below to add required Visual Basic for Applications references)
d. Click “Stop” on the bottom of the pop-up (this will close the Blank.accdb file)
d. Click “Stop” on the bottom of the pop-up (this will close the Blank.accdb file)
<img src="SedimentFingerprinting_R/readMeImages/Figure1.jpg" alt="Sed_Sat" height="550px" align="center" />
3) Enable Content in the Sed_SAT.accdb file
3) Enable Content in the Sed_SAT.accdb file
a. Open the Sed_SAT.accdb file
a. Open the Sed_SAT.accdb file
b. Close the Pop-up window by clicking the “X” in the top right corner
b. Close the Pop-up window by clicking the “X” in the top right corner
c. Click “Enable Content” in the yellow ribbon on the top of the widow (if an error
occurs after enabling content this is due to a missing Visual Basic for Applications reference, see Activating Microsoft Access Visual Basic References to add required Visual Basic for Applications references.)
c. Click “Enable Content” in the yellow ribbon on the top of the widow (if an error
occurs after enabling content this is due to a missing Visual Basic for Applications reference, see Activating Microsoft Access Visual Basic References to add required Visual Basic for Applications references.)
d. All content is now enabled, and the program is ready to run
d. All content is now enabled, and the program is ready to run
Enabling content is a one-time process as long as the program remains in one location. Each time the program is moved to a new location you will need to enable content in the new location in all three files in the order above.
......@@ -117,7 +119,8 @@ If an error occurs after enabling content, the Visual Basic Editor window will o
6. Uncheck any references that start with “MISSING”
7. Select the required Visual Basic for Applications references listed above
8. Click OK
<img src="SedimentFingerprinting_R/readMeImages/Figure5.png" alt="Sed_Sat" height="550px" align="center" />
......@@ -156,13 +159,13 @@ The column headers for target, source, and reporting limit data do not have to m
11. All samples MUST be unique; replicates/duplicates should be evaluated and removed prior to importing data.
## Navigating Sed_SAT
Sed_SAT is designed to run in a linear fashion from beginning to end. The Program MAP (Figure 7) is designed to allow the user to navigate steps, view data tables/results that have already been completed, and/or start running the model at a previously completed step. If this the first time the program is run, the user will see a Welcome Screen to start the program click “Start” or view the Program MAP. The Program MAP can be accessed from any screen in the program by clicking the Program MAP icon <img src="SedimentFingerprinting_R/readMeImages/Figure6.png" alt="Sed_Sat" height="100" align="right" />
<img src="SedimentFingerprinting_R/readMeImages/Figure6.png" alt="Sed_Sat" height="100" align="right" />Sed_SAT is designed to run in a linear fashion from beginning to end. The Program MAP (Figure 7) is designed to allow the user to navigate steps, view data tables/results that have already been completed, and/or start running the model at a previously completed step. If this the first time the program is run, the user will see a Welcome Screen to start the program click “Start” or view the Program MAP. The Program MAP can be accessed from any screen in the program by clicking the Program MAP icon
The Program MAP is NOT designed to allow the user to skip steps. Skipping steps using the Program MAP will at best cause the program to fail and at worst cause corrupted results. Throughout the normal progression of the program, however, opportunities to skip various steps will be made available. Skipping steps using this method is acceptable and will yield appropriate results.
<img src="SedimentFingerprinting_R/readMeImages/Figure7top.png" alt="Sed_Sat" height="750px" align="center" />
<img src="SedimentFingerprinting_R/readMeImages/Figure7bottom.png" alt="Sed_Sat" height="750px" align="center" />
<img src="SedimentFingerprinting_R/readMeImages/Figure7caption.png" alt="Sed_Sat" height="750px" align="center" />
<img src="SedimentFingerprinting_R/readMeImages/Figure7caption.png" alt="Sed_Sat" height="200px" align="center" />
#### Buttons
As the program runs, each step’s output is updated and overwritten. All buttons that run an Rscript that overwrites data are teal, and all buttons that simply navigate to an output are black. This color scheme allows the user to differentiate between buttons that will alter/delete data and that shouldn’t be run out of order from buttons that simply navigate.
......@@ -171,10 +174,10 @@ As the program runs, each step’s output is updated and overwritten. All butto
The Blank.accdb file is a mostly empty database with the sole purpose of returning the user to the primary Sed_SAT.accdb file. This allows the Sed_SAT.accdb file to be updated by the Rscripts being run. The only screen in the Blank.accdb file is shown below
<img src="SedimentFingerprinting_R/readMeImages/Figure10.png" alt="Sed_Sat" height="550px" align="center" />
<img src="SedimentFingerprinting_R/readMeImages/Figure10.jpg" alt="Sed_Sat" height="550px" align="center" />
### User - friendly Step-by-Step guides
Follow all user prompts as they appear to exectute the statitical steps in Sed_SAT.
Follow all user prompts as they appear to exectute the statitical steps in Sed_SAT. For more detailed instructions on all steps see the [Instruction Manual](https://code.usgs.gov/lgormansanisaca/sed_sat/blob/master/SedimentFingerprinting_R/Manual/InstructionManual.docx)
#### Acknowledgments
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment