-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdocumentation.R
97 lines (90 loc) · 11.2 KB
/
documentation.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#Documentation tab
#Two columns
#one with description of each page
#one with each update
documentationUI <- function(id, label = "documentation"){
tabPanel("Documentation", value = "readme_tab",
titlePanel("MARS Fieldwork Database v3.1"),
column(width = 5,
h2("User Guide"),
h3("Deployments"),
h4("Collection Calendar"),
h5("The Collection Calendar tab presents a table of all active deployments. The sidebar has filters for property type, interval, and capacity. The table is searchable, and the \"80% Full Date\" column is highlighted yellow if that date has passed. The \"100% Full Date\" column is highlighted red if that date has passed. Click a row to go to the \"Deploy Sensor\" tab, where the same deployment will be selected and available to edit."),
h4("Deploy Sensor"),
h5("Add a new sensor deployment by filling out SMP ID (or Site Name), location, sensor serial number, purpose (baro or level), interval (5 or 15 mintues), and deployment date. Collection date is optional. Only SMP ID (or Site Name) and location are required for future deployments. Deployments with dataloggers do not have a sensor serial number. New deployments can not be added for sensors that are already deployed elsewhere. Edit existing deployments by clicking on either the active or previous deployments table. Once a collection date is added, you can enter whether there was a download error. If there was a download error, you can check whether the sensor is broken. A checkbox is presented with the option to redeploy the sensor. If the broken sensor and redeploy checkboxes are both checked, you must enter a new sensor ID. If that's the case, then upon deployment, three entries to the database will be made: one for the collected deployment (which could be an edit of a previous active deployment), one for the new active deployment, and one that notes that the original sensor is broken. The tables will instantly update with new deployments."),
h4("Future Deployments"),
h5("The Future Deployments tab presents a table of all future, or planned, deployments. Click a row to go to the Deploy Sensor tab, where the same deployment should be selected and available to edit."),
h3("Add Location"),
h5("Choose whether to add a location at an SMP or non-SMP site (\"Site\")."),
h5("If SMP: Select an SMP ID to give options for Component ID. A suggested Location (ie, OW1) is autofilled, which can be overwritten if needed. Facility ID is autofilled based on the selected Component ID. If the selected feature does not have a component ID, the facility ID of the SMP will be used. Once all field in the top sidebar are complete, and the new location does not already exist, add the location using the button in the top left panel. Click a row on the table to enable editing of location. Use the lower sidebars to add or edit well measurements for the location from fieldnotes. \nFor observation wells and inlets, you can also use the sidebars to populate elevations from the plan set, and select the preferred sump and orifice depths between default assumptions, QAQC interpreted depths, and values calculated from reviewing plan sets."),
h5("If Site: Select a Site in the dropdown. If the Site you need isn't there, you can add it by checking off \"Add New Site?\" and typing a new name. Once you click, it will appear in the dropdown. Select a component ID and location. If \"At SMP\" is blank, you can check a box if you want to move monitoring locations from a site to an SMP. This is useful if a monitored pre-construction site was given an SMP ID. The locations will be assigned to that SMP ID, and the site name will removed."),
h3("Add Sensor"),
h5("Add a new sensor to the inventory by entering sensor serial number, model number, and sensor status. Purchase date is optional. Edit existing sensors by entering the sensor serial number, or clicking on the desired table row. The table can be sorted and searched. Click \"Deploy this Sensor\" to go to the \"Deploy Sensor\" tab with the sensor selected."),
h3("Simulated Runoff Tests"),
h4("Add/Edit SRT"),
h5("Add or edit an SRT record. System ID, Test Date, and SRT Type are required fields. Edit by selecting an System ID from the drop-down, and then clicking on one of the table rows to the right. All previously recorded fields (including those not shown in the table) will autofill. Future SRTs only require an System ID and no date."),
h4("View SRTs"),
h5("View all recorded SRTs. Records per page can be adjusted and records can be sorted by clicking on the column header. Clicking the triangle on the left will show the SRT summary. Similar to the Collection Calendar, clicking on a row goes to the \"Add/Edit SRT\" tab where the same record will be selected and ready to edit."),
h4("View Future SRTs"),
h5("View all future SRTs. This works the same as the View SRTs tab."),
h3("Special Investigations"),
h4("Add/Edit Special Investigation"),
h5("Add or edit a Special Investigation record. System ID (or Work Number, or Site Name), Special Investigation Type, Requested By, and Test Date are required fields. Edit by selecting System Id from the drop-down, and then clicking on one of the table rows. All previously recorded fields will autofill. System ID (or Work Number or Site Name) are required to add future tests."),
h4("View Special Investigations"),
h5("View all recorded Special Investigations. Table can be searched, sorted, and adjusted. Clicking on a row goes to the \"Add/Edit Special Investigation\" tab where the same record will be selected and ready to edit."),
h4("View Future Special Investigations"),
h5("View all future Special Investigations. This works the same as the View Special Investigations tab.")
),
column(width = 5, offset = 1,
h2("Current Status"),
h3("v3.2"),
h5("Final edits by Brian Cruice. Improvements to several bugs and warnings in the deploy tab. Sensor history table addition. Introduction of logging mechanism, which is present in the live version for well measurements and ready for beta everywhere else."),
h3("v3.1"),
h5("Major revisions to the \"Add/Edit Location\" tab centered around improving well measurment accuracy, including the ability to write custom sump and orifice elevations to the database"),
h3("v1.4.2"),
h5("Patched bugs related to 1.4.1 UI improvements, edited SRT collection times, and reworded well measurement sections to remove ambiguity. \"Collection calendar\" now passes more data to \"deploy\" to improve logic."),
h3("v1.4.1"),
h5("UI improvements within 'Add Location' and warning messaging."),
h3("v1.4"),
h5("Removed Stats, Inlet Conveyance, Porous Pavement, and Capture Efficiency and moved to their own apps."),
h3("v1.3"),
h5("Updated big selectInputs to be server-side selectizeInputs to improve initialization speed. Replaced deprecated or superseded function and improved backend readability. Fixed local reactable nest issue and table-selection issue."),
h3("v1.2"),
h5("Added Pre-Monitoring Inspection notes for future deployments, details for sensor issues, and more UI improvements."),
h3("v1.1"),
h5("v1.1 has the same core features as v1.0 but improved user experience and functionality."),
h3("v1.0"),
h5("All features of the previously used Current Monitoring Sites and Field Testing Master Record spreadsheets have been integrated. MARS Field staff shall use this app to enter all fieldwork data into the MARS Fieldwork database. Since v0.6, inlet conveyance tests and special investigations have been added, with some adjustments to user experience, and smaller back end adjustments"),
h3("v0.6"),
h5("An introduction to working with sites without an SMP ID. They will be referred to as \"Sites\", while locations with an SMP ID are \"SMPs\" or \"Systems\". You can add monitoring locations and deployments (future, active, and previous) at sites, and track them in the collection calendar like SMPs."),
h3("v0.5.2"),
h5("Future SRTs, Porous Pavement Tests, and Capture Efficiency Tests can be added and edited."),
h3("v0.5.1"),
h5("Added future deployments; they can be added by just entering an SMP ID and OW Suffix in the Deploy tab. They can be edited by clicking the row, or by clicking the row in the Future Deployments tab."),
h3("v0.5"),
h5("Added the ability to view, add, and edit well measurements on the \"Add OW\" tab. Users should enter their deployment and collection info here and in the \"Current Monitoring Sites\" spreadsheet and give feedback to Nick; once updates are made, CMS can be partially phased out."),
h3("v0.4.1"),
h5("Added new deployment attributes and updated collection calendar; added reactive headers."),
h3("v0.4"),
h5("Added Monitoring Stats and made updates to Deploy, Collection Calendar, and Capture Efficiency."),
h3("v0.3.2"),
h5("Added Capture Efficiency tab."),
h3("v0.3.1"),
h5("Added Porous Pavement tab for Porous Pavement Tests, which includes the \"Add/Edit Porous Pavement Tests\" page and \"View Porous Pavement Tests\" page."),
h3("v0.3"),
h5("Added SRT tab for Simulated Runoff Tests, which includes the \"Add/Edit SRT\" page and \"View All SRTs\" page."),
h3("v0.2.1"),
h5("Updated the \"Deploy Sensor\" tab to help prevent accidental double deployment of the same sensor, and to clear inputs (other than SMP ID) and deselect rows following an add or edit."),
h3("v0.2"),
h5("Some user feedback has been incorporated, including adding dialogue boxes to confirm actions on the \"Deploy Sensor\" tab. The public/private filter on the \"Collection Calendar\" tab has been updated to work properly."),
h3("v0.1"),
h5("This is the user testing phase. Changes will be made based on feedback, then v1.0 will be issued. Current tabs include:" , style = "margin-left: 10px"),
HTML("<h5><ul>
<li>Collection Calendar</li>
<li>Add Location</li>
<li>Add Sensor</li>
<li>Deploy Sensor</li>
<li>Documentation</li>
</ul></h5>"),
))
}