diff --git a/docs/src/administrator/manual/django-add-record.md b/docs/src/administrator/manual/django-add-record.md index 35e7a2a..107e12f 100644 --- a/docs/src/administrator/manual/django-add-record.md +++ b/docs/src/administrator/manual/django-add-record.md @@ -31,3 +31,39 @@ The administrators will be presented with a form to enter the user's information 5. **Save and add another**: Save the current record, then redirect to a new page to add a new record. 6. **Save and continue editing**: Save the current record while still showing the current record. + +## Add R Model Record + +![Add R Model](./img/django-add-record-2.png) + +**Form Fields**: Researchers have the ability to create a new R Model record by filling out the form fields. The following fields are available for input: + +- **Name**: A unique identifier for the R Model. +- **Version**: The version number of the R Model. +- **Code**: The R code used to produce plant/no plant signals. +- **Notes**: Additional comments or notes about the R Model. + +- **Created On**: The date and time the R Model was created. Researchers can select the date from the calendar or set it to the current date by clicking on the `Today` button. The time can be set by clicking on the clock icon or set to the current time by clicking on the `Now` button. + +- **Created By**: A dropdown menu listing the available researchers who can create R Models. + +- **Updated On:** The date and time the R Model was last updated. Researchers can select the date from the calendar or set it to the current date by clicking on the `Today` button. The time can be set by clicking on the clock icon or set to the current time by clicking on the `Now` button. + +- **Updated By:** A dropdown menu listing the available researchers who can update R Models. + +![Error](./img/django-add-record-3.png) + +Fill all the required fields to save the r model record otherwise it will throw an error. + +![Error](./img/django-add-record-4.png) + + +1. **R MODEL OUTPUTS:** Click on the dropdown to select the type and enter the name into the variable name field. + +2. **Save**: This option saves the new R Model record and redirects administrators to the Django Admin Table/record list. + +3. **Save and Add Another**: This option saves the new R Model record and redirects administrators to a new page to add another R Model record. + +4. **Save and Continue Editing**: Choosing this option saves the new R Model record while still displaying the current record for further editing. + +By following these steps, researchers can efficiently create and manage R Model records within the GAP Admin interface. \ No newline at end of file diff --git a/docs/src/administrator/manual/django-change-record.md b/docs/src/administrator/manual/django-change-record.md index e226d62..f4bf00f 100644 --- a/docs/src/administrator/manual/django-change-record.md +++ b/docs/src/administrator/manual/django-change-record.md @@ -58,4 +58,39 @@ license: This program is free software; you can redistribute it and/or modify it 4. **Save and continue editing**: Save the current record while still showing the current record. -5. **Delete**: The administrators can delete the user by clicking on this button. The popup will open for the confirmation to delete the user. \ No newline at end of file +5. **Delete**: The administrators can delete the user by clicking on this button. The popup will open for the confirmation to delete the user. + +## Change R Model + +![Change r model](./img/django-change-record-5.png) + +1. **History**: Button to view actions applied to the current record. + +2. **Form Fields**: Researchers have the ability to update the values of various fields within the R Model form. The following fields are available for editing: + +- Name +- Version +- Code +- Notes + +![Change r model](./img/django-change-record-6.png) + +- Created On: The date and time the R Model was created. Researchers can select the date from the calendar or set it to the current date by clicking on the `Today` button. The time can be set by clicking on the clock icon or set to the current time by clicking on the `Now` button. + +- Created By: A dropdown menu listing the available researchers who can create R Models. + +- Updated On: The date and time the R Model was last updated. Researchers can select the date from the calendar or set it to the current date by clicking on the `Today` button. The time can be set by clicking on the clock icon or set to the current time by clicking on the `Now` button. + +- Updated By: A dropdown menu listing the available researchers who can update R Models. + +3. **Delete Checkbox**: Check mark the checkbox to delete the associated r model outputs. + +4. **Save**: This option saves the current r model record and redirects administrators to the Django Admin Table/record list. + +5. **Save and Add Another**: This option saves the current rmodel record and redirects administrators to a new page to add another r model record. + +6. **Save and Continue Editing**: Choosing this option saves the current r model record while still displaying the current record for further editing. + +7. **Delete**: The administrator can delete the r model by clicking on the `Delete` button. It will ask for confirmation to delete the r model object. + + ![Delete r model](./img/django-change-record-7.png) diff --git a/docs/src/administrator/manual/django-table.md b/docs/src/administrator/manual/django-table.md index c28913f..773aec9 100644 --- a/docs/src/administrator/manual/django-table.md +++ b/docs/src/administrator/manual/django-table.md @@ -36,3 +36,33 @@ The user table within the Django Admin interface allows administrators to manage 5. **Edit User**: Clicking on the object allows the administrators to change or edit a particular record. Click [here](django-change-record.md) to view detailed documentation on editing a user. + +## R Model Table + +The R Model table within the GAP Admin interface allows researchers to manage and track different versions of the R code used to produce plant/no plant signals. + +![R Table](./img/django-table-3.png) + +1. **Add R Model:** Clicking on the `ADD R MODEL` button allows researchers to add a new version of the R code. Click [here](django-add-record.md) to see detailed documentation on adding a new R model. + +2. **R Model Table:** The R Model table with records, displaying information such as the version number, description, and date added. + +3. **Action Dropdown:** The Action dropdown of the R Model table and allows researchers to perform various actions on the records. To access the Action Dropdown, click on the dropdown. + + ![Action](./img/django-table-4.png) + + **Performing Actions:** To perform an action on a record, follow these steps: + + - Select Records: Check the box available in front of the records to perform the action on. + + - Choose Action: Select the desired action from the dropdown menu. + + - Go Button: Click on the Go button to execute the chosen action. + + The available actions include: + + - Delete selected r model: Permanently remove the selected record(s) from the R Model table. + + - Restart plumber process: Restarts the plumber process. + +4. **Edit R Model:** Clicking on the object allows researchers to change or edit a particular version of the R code. Click [here](django-change-record.md) to view detailed documentation on editing an R model. diff --git a/docs/src/administrator/manual/img/django-add-record-2.png b/docs/src/administrator/manual/img/django-add-record-2.png new file mode 100644 index 0000000..9a2545c Binary files /dev/null and b/docs/src/administrator/manual/img/django-add-record-2.png differ diff --git a/docs/src/administrator/manual/img/django-add-record-3.png b/docs/src/administrator/manual/img/django-add-record-3.png new file mode 100644 index 0000000..47012d3 Binary files /dev/null and b/docs/src/administrator/manual/img/django-add-record-3.png differ diff --git a/docs/src/administrator/manual/img/django-add-record-4.png b/docs/src/administrator/manual/img/django-add-record-4.png new file mode 100644 index 0000000..006dd00 Binary files /dev/null and b/docs/src/administrator/manual/img/django-add-record-4.png differ diff --git a/docs/src/administrator/manual/img/django-change-record-5.png b/docs/src/administrator/manual/img/django-change-record-5.png new file mode 100644 index 0000000..46055f1 Binary files /dev/null and b/docs/src/administrator/manual/img/django-change-record-5.png differ diff --git a/docs/src/administrator/manual/img/django-change-record-6.png b/docs/src/administrator/manual/img/django-change-record-6.png new file mode 100644 index 0000000..37bad1f Binary files /dev/null and b/docs/src/administrator/manual/img/django-change-record-6.png differ diff --git a/docs/src/administrator/manual/img/django-change-record-7.png b/docs/src/administrator/manual/img/django-change-record-7.png new file mode 100644 index 0000000..319c8da Binary files /dev/null and b/docs/src/administrator/manual/img/django-change-record-7.png differ diff --git a/docs/src/administrator/manual/img/django-table-3.png b/docs/src/administrator/manual/img/django-table-3.png new file mode 100644 index 0000000..158cb0e Binary files /dev/null and b/docs/src/administrator/manual/img/django-table-3.png differ diff --git a/docs/src/administrator/manual/img/django-table-4.png b/docs/src/administrator/manual/img/django-table-4.png new file mode 100644 index 0000000..0778986 Binary files /dev/null and b/docs/src/administrator/manual/img/django-table-4.png differ