Update ugdg #153
Merged
Update ugdg #153
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/UserGuide.adoc
Outdated
| @@ -366,7 +366,7 @@ Deletes a person with the NRIC S98654322D in ORGANice. | |||
| === Detecting matches: `match` | |||
|
|
|||
| This command runs a kidney matching test on patients and donors in ORGANice and displays the match results. | |||
| Refer to <<FAQ>> for a better understanding of the procedure for kidney matching. | |||
| Refer to <<Glossary>> for a better understanding of the procedure for kidney matching. | |||
There was a problem hiding this comment.
FAQ seems correct here why change to Glossary
docs/UserGuide.adoc
Outdated
| @@ -562,6 +583,9 @@ that contains the data of your previous ORGANice folder. | |||
| 2. Do a tissue typing test to determine the HLA antigens of the patient and the donor. | |||
| 3. Do a cross match, which is a trial transfusion. | |||
|
|
|||
| *Q*: What is the success rate and how is it computed? + | |||
| *A*: | |||
There was a problem hiding this comment.
The success rate measures the tissue compatibility between a donor and a patient. It is computed via this formula: (number of common tissue types between donor and patient) / 6 * 100%
C-likethis123
requested changes
Oct 30, 2019
docs/UserGuide.adoc
Outdated
|
|
||
| === Sorting matches: `sort` | ||
| Users can specify how they want the patient-donor pairs to be sorted. + | ||
| Sorting is done by passing in optional parameters to the `match` command. + | ||
| This section specifies how a list of matches can be sorted to determine which patient to prioritize for organ transplant. |
There was a problem hiding this comment.
Better tone to sound as if you are talking with the user? Such as, After getting the list of potential donors, you can ........
docs/UserGuide.adoc
Outdated
|
|
||
| Matches can be sorted according to three categories: | ||
| **The sort command can only be used after a match command** to sort the resulting list of patient-donor pairs generated. | ||
| The following specifies three categories by which you can sort the matches. |
There was a problem hiding this comment.
I expect 3 bullet points if you said this, so can add in the 3 categories as bullet points her maybe
docs/UserGuide.adoc
Outdated
| 1. Success rate of match | ||
| 2. Priority of patient | ||
| 3. Date of expiry of donors' organs | ||
| 1. Sorting based on donor's organ expiry date |
There was a problem hiding this comment.
i prefer bullet points though cause order here doesnt matter. What do you think?
27 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
update model class diagram image
update ugdg for sorting feature