|
1 | | -# Utility Guide: fit_kit_generation |
| 1 | +# Utility Guide: Fit Kit Generation |
2 | 2 |
|
3 | | -The fit_kit_generation Utility provides methods to generate and manage FIT test kits for testing purposes. |
| 3 | +The Fit Kit Generation Utility provides methods to generate and manage FIT test kits for testing purposes. |
4 | 4 |
|
5 | 5 | ## Table of Contents |
6 | 6 |
|
7 | | -- [Utility Guide: fit\_kit\_generation](#utility-guide-fit_kit_generation) |
| 7 | +- [Utility Guide: Fit Kit Generation](#utility-guide-fit-kit-generation) |
8 | 8 | - [Table of Contents](#table-of-contents) |
9 | | - - [Using the fit\_kit\_generation Utility](#using-the-fit_kit_generation-utility) |
| 9 | + - [Using the Fit Kit Generation Utility](#using-the-fit-kit-generation-utility) |
10 | 10 | - [Required Arguments](#required-arguments) |
11 | | - - [fit\_kit\_generation Specific Functions](#fit_kit_generation-specific-functions) |
| 11 | + - [Fit Kit Generation Specific Functions](#fit-kit-generation-specific-functions) |
12 | 12 | - [Example Usage](#example-usage) |
13 | 13 |
|
14 | | -## Using the fit_kit_generation Utility |
| 14 | +## Using the Fit Kit Generation Utility |
15 | 15 |
|
16 | | -To use the fit_kit_generation Utility, import the `fit_kit_generation` module, from the `utils` directory, into your test file and call its methods from within your tests, as required. |
| 16 | +To use the Fit Kit Generation Utility, import the `fit_kit_generation` module, from the `utils` directory, into your test file and call its methods from within your tests, as required. |
17 | 17 |
|
18 | 18 | ## Required Arguments |
19 | 19 |
|
20 | 20 | The methods in this utility require specific arguments. Below is a summary of the required arguments for key methods: |
21 | 21 | - `generate_kit`: Requires `batch_id` (int) and `kit_type` (str). |
22 | 22 |
|
23 | | -## fit_kit_generation Specific Functions |
| 23 | +## Fit Kit Generation Specific Functions |
24 | 24 |
|
25 | | -The fit_kit_generation Utility includes methods for generating, validating, and managing FIT test kits. These methods are designed to streamline the process of creating test kits for various scenarios. Below are some key functions: |
| 25 | +The Fit Kit Generation Utility includes methods for generating, validating, and managing FIT test kits. These methods are designed to streamline the process of creating test kits for various scenarios. Below are some key functions: |
26 | 26 |
|
27 | 27 | 1. **`create_fit_id_df(tk_type_id: int, hub_id: int, no_of_kits: int) -> DataFrame`** |
28 | 28 | Creates a DataFrame containing FIT kit IDs based on the provided parameters. |
|
0 commit comments