Metadata-Version: 2.1
Name: TFLsTool
Version: 0.0.3
Summary: This is a toolkit related to TFL (Tables, Figures, and Listings) generation in the field of clinical biostatistics for pharmaceuticals.
Home-page: https://github/allensrj/
Author: allensrj
Author-email: allensrj@qq.com
License: MIT
Description-Content-Type: text/markdown

# Description

This is a toolkit related to TFL (Tables, Figures, and Listings) generation in the field of clinical biostatistics for pharmaceuticals.

# Main Features

* `extract_shell_to_tracker()` extracting table types, table numbers, titles, and footnotes from DOCX format mock shells into a tracker, enabling statistical programmers to efficiently generate TFLs.
* `completeness_report()` extract the completion status of the Production side and QC side from the tracker.xlsx, and then create graphs report based on the status and send emails. 

# Installation

```python
pip install TFLsTool
```

# Example
After installing the package, fill in the parameters and run the function using the example below.

```python
from TFLsTool import extract_shell_to_tracker
from TFLsTool import completeness_report

extract_shell_to_tracker(
    table_path='./project-table.docx',
    table_conditions_list=[["Table", re.compile(r'\d'), '.']],
    
    listing_path='./project-listings.docx',
    listing_conditions_list=[["Listing", re.compile(r'\d'), '.']],
    
    figure_path='./project-figures.docx',
    figure_conditions_list=[["Figures", re.compile(r'\d'), '.']],

    title_split='\n',
    language='EN',
    output_path='./tracker_results.xlsx'
)

completeness_report(
    file_path='./tracker.xlsx',
    sheet_name='sheet',
    ds_select_list=['Type', 'SP', 'Pstatus', 'QC', 'Qstatus'],
    ds_status_list=['Ready', 'Complete'],
    project='Test Project',
    side='all',

    email_sender=[
        'your email',
        'your password'
    ],
    email_recipient=['5211314@qq.com', '5211314@gmail.com'],
    email_cc=['5211314@outlook.com'],
    outpath='./data'
)
```

More information is available in the https://github.com/allensrj/TFLsTool
