Skip to content

Commit 93f278b

Browse files
committed
Addressed commit errors
1 parent 75d52ed commit 93f278b

File tree

1 file changed

+39
-38
lines changed

1 file changed

+39
-38
lines changed

docs/utility-guides/InvestigationDataset.md

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -36,66 +36,67 @@ The methods in this utility require specific arguments. Below is a summary of th
3636

3737
Required arguments for main method:
3838
- result (str): The result of the investigation dataset. Should be one of InvestigationDatasetResults (HIGH_RISK, LNPCP, NORMAL).
39-
- younger (bool): True if the subject is younger than 50, False otherwise.
39+
- younger (`bool`): True if the subject is younger than 50, False otherwise.
4040

4141
## Investigation Dataset Specific Functions
4242

4343
The `investigation_dataset` utility is used to complete the investigation dataset forms for a subject.It contains methods to fill out the forms, and progress episodes, based on the age of the subject and the test result. Below are their key functions:
4444

4545
1. **`complete_with_result(self, nhs_no: str, result: str) -> None`**
46-
This method fills out the investigation dataset forms based on the test result and the subject's age.
46+
This method fills out the investigation dataset forms based on the test result and the subject's age.
4747

48-
- **Arguments**:
49-
- nhs_no (str): The NHS number of the subject.
50-
- result (str): The result of the investigation dataset. Should be one of InvestigationDatasetResults (HIGH_RISK, LNPCP NORMAL).
48+
- **Arguments**:
49+
- nhs_no (str): The NHS number of the subject.
50+
- result (str): The result of the investigation dataset. Should be one of InvestigationDatasetResults (HIGH_RISK, LNPCP NORMAL).
5151

52-
1. **`go_to_investigation_datasets_page(self, nhs_no) -> None`**
53-
This method navigates to the investigation datasets page for a subject.
52+
2. **`go_to_investigation_datasets_page(self, nhs_no) -> None`**
53+
This method navigates to the investigation datasets page for a subject.
5454

55-
- **Arguments**:
56-
- nhs_no (str): The NHS number of the subject.
55+
- **Arguments**:
56+
- nhs_no (str): The NHS number of the subject.
5757

58-
1. **`default_investigation_dataset_forms(self) -> None`**
59-
This method fills out the first part of the default investigation dataset form.
58+
3. **`default_investigation_dataset_forms(self) -> None`**
59+
This method fills out the first part of the default investigation dataset form.
6060

61-
2. **`default_investigation_dataset_forms_continuation(self) -> None`**
62-
This method fills out the second part of the default investigation dataset form.
61+
4. **`default_investigation_dataset_forms_continuation(self) -> None`**
62+
This method fills out the second part of the default investigation dataset form.
6363

64-
3. **`investigation_datasets_failure_reason(self) -> None`**
65-
This method fills out the failure reason section of the investigation dataset form.
64+
5. **`investigation_datasets_failure_reason(self) -> None`**
65+
This method fills out the failure reason section of the investigation dataset form.
6666

67-
4. **`polyps_for_high_risk_result(self) -> None`**
68-
This method fills out the polyp information section of the investigation dataset form to trigger a high risk result.
67+
6. **`polyps_for_high_risk_result(self) -> None`**
68+
This method fills out the polyp information section of the investigation dataset form to trigger a high risk result.
6969

70-
5. **`polyps_for_lnpcp_result(self) -> None`**
71-
This method fills out the polyp information section of the investigation dataset form to trigger a LNPCP result.
70+
7. **`polyps_for_lnpcp_result(self) -> None`**
71+
This method fills out the polyp information section of the investigation dataset form to trigger a LNPCP result.
7272

73-
6. **`polyp1_intervention(self) -> None`**
74-
This method fills out the intervention section of the investigation dataset form for polyp 1.
73+
8. **`polyp1_intervention(self) -> None`**
74+
This method fills out the intervention section of the investigation dataset form for polyp 1.
7575

76-
7. **`save_investigation_dataset(self) -> None`**
77-
This method saves the investigation dataset form.
76+
9. **`save_investigation_dataset(self) -> None`**
77+
This method saves the investigation dataset form.
7878

79-
8. **`progress_episode_based_on_result(self, result: str, younger: bool) -> None`**
80-
This method progresses the episode based on the result of the investigation dataset.
81-
- **Arguments**:
82-
- result (str): The result of the investigation dataset. Should be one of InvestigationDatasetResults (HIGH_RISK, LNPCP, NORMAL).
83-
- younger (bool): True if the subject is younger than 50, False otherwise.
79+
10. **`progress_episode_based_on_result(self, result: str, younger: bool) -> None`**
80+
This method progresses the episode based on the result of the investigation dataset.
8481

85-
9. **`after_high_risk_result(self) -> None`**
86-
This method advances an episode that has a high-risk result.
82+
- **Arguments**:
83+
- result (str): The result of the investigation dataset. Should be one of InvestigationDatasetResults (HIGH_RISK, LNPCP, NORMAL).
84+
- younger (`bool`): True if the subject is younger than 50, False otherwise.
85+
86+
11. **`after_high_risk_result(self) -> None`**
87+
This method advances an episode that has a high-risk result.
8788

88-
10. **`after_lnpcp_result(self) -> None`**
89-
This method advances an episode that has a LNPCP result.
89+
12. **`after_lnpcp_result(self) -> None`**
90+
This method advances an episode that has a LNPCP result.
9091

91-
11. **`after_normal_result(self) -> None`**
92-
This method advances an episode that has a normal result.
92+
13. **`after_normal_result(self) -> None`**
93+
This method advances an episode that has a normal result.
9394

94-
12. **`handover_subject_to_symptomatic_care(self) -> None`**
95-
This method hands over a subject to symptomatic care.
95+
14. **`handover_subject_to_symptomatic_care(self) -> None`**
96+
This method hands over a subject to symptomatic care.
9697

97-
13. **`record_diagnosis_date(self) -> None`**
98-
This method records the diagnosis date for a subject.
98+
15. **`record_diagnosis_date(self) -> None`**
99+
This method records the diagnosis date for a subject.
99100

100101
## Example Usage
101102

0 commit comments

Comments
 (0)