mscore 25.3.0__tar.gz → 25.3.2__tar.gz

{mscore-25.3.0 → mscore-25.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mscore
-Version: 25.3.0
+Version: 25.3.2
 Summary: MScore: Risk Scores Made Easy
 Home-page: https://github.com/elevendatacorp/mscore.git
 Author: RAM Development Team
@@ -92,7 +92,6 @@ The <code>mscore</code> class requires 7 arguments in order to run with 2 option
 * <code>columns</code> 
 
 ### Optional
-* <code>rf-output</code> (boolean) - Generates a file of your scores Relative Factors
 * <code>dev</code> (boolean) - Runs the application in 'Development' mode
 
  **_NOTE:_**  The example below assumes you already have a [Pandas](https://pandas.pydata.org/) DataFrame generated for your person and diagnosis datasets.
@@ -124,8 +123,7 @@ model = MScore(
 
 scores = model.score_mscore()
 
-print(scores.risk_scores)
-print(scores.relative_factors)
+risk_scores = scores.risk_scores
 ```
 The resulting 'scores' output is a data model object of pandas.DataFrames. You can access your risk scores or relative factors data sets by calling the respective model name from the grouped data model. 
 - <span style="font-family:courier-new">scores.risk_scores</span>
@@ -133,6 +131,27 @@ The resulting 'scores' output is a data model object of pandas.DataFrames. You c
 
 From here you can proceed to use the risk score or relative factor DataFrames for further downstream processing or utilize the [Pandas](https://pandas.pydata.org/docs/user_guide/index.html) built-in methods to save to a file type of your choosing.
 
+### Features
+#### relative_factors (attribute)
+MScore offers the ability to view the relative factors for each person run through M<span style="font-size:.8em;">SCORE<sup>®</sup></span>. To access this data, you simply access the <code>relative_factors</code> attribute of the <code>mscore</code> output. The relative factors are the individual contributions (from the variables in the model) to the risk score. M<span style="font-size:.8em;">SCORE's<sup>®</sup></span> <code>relative_factors</code> output contains these values with 1 row per person scored, and each relative factor in the output as the columns.
+
+To leverage this feature, you would do the following:
+```python
+relative_factors = scores.relative_factors
+```
+#### get_disease_scores (method)
+For users wanting to compute the disease contribution to a person's risk score, you can do this in MScore by using the <code>get_disease_score</code> method of <code>mscore</code>. After instantiating your <code>mscore</code> object, you can use <code>get_disease_score</code> and pass the <code>mscore</code> output as a parameter. This will create a new dataframe containing only the portion of the risk score that comes from disease factors. Alternatively, if you would like this data appended to your MScore risk score output, you can use <code>join_scores</code> parameter to do this. NOTE: Disease interactions with DISABLED variables are not included in the disease score. 
+
+You can use the <code>get_disease_score</code> method as here:
+```python
+    disease_scores = model.get_disease_scores(scores)
+```
+
+Or using the <code>join_scores</code> parameter:
+```python
+    disease_scores = model.get_disease_scores(scores, join_scores=True)
+```
+
 ### Supported Data
 The <code>mscore</code> class attributes, <code>person_data</code> and <code>diag_data</code>, will accept a Pandas.DataFrame object, CSV or Parquet filepath directly without the need to load your input data to DataFrame first. The resulting outputs will be a Pandas DataFrame object.
 
@@ -140,8 +159,8 @@ The <code>mscore</code> class attributes, <code>person_data</code> and <code>dia
 
 M<span style="font-size:.8em;">SCORE<sup>®</sup></span> is designed to be universally compatible, ensuring seamless integration across various platforms.
 
-•	Operating Systems:  Windows, macOS, Linux
-•	Python Versions: 3.10 or greater (both 32-bit and 64-bit architectures)
+- Operating Systems:  Windows, macOS, Linux
+- Python Versions: 3.10 or greater (both 32-bit and 64-bit architectures)
 
 If your required environment is not listed, please contact us as support@riskadjustmentmodel.com for an alternate solution.
 

{mscore-25.3.0 → mscore-25.3.2}/README.md

@@ -67,7 +67,6 @@ The <code>mscore</code> class requires 7 arguments in order to run with 2 option
 * <code>columns</code> 
 
 ### Optional
-* <code>rf-output</code> (boolean) - Generates a file of your scores Relative Factors
 * <code>dev</code> (boolean) - Runs the application in 'Development' mode
 
  **_NOTE:_**  The example below assumes you already have a [Pandas](https://pandas.pydata.org/) DataFrame generated for your person and diagnosis datasets.
@@ -99,8 +98,7 @@ model = MScore(
 
 scores = model.score_mscore()
 
-print(scores.risk_scores)
-print(scores.relative_factors)
+risk_scores = scores.risk_scores
 ```
 The resulting 'scores' output is a data model object of pandas.DataFrames. You can access your risk scores or relative factors data sets by calling the respective model name from the grouped data model. 
 - <span style="font-family:courier-new">scores.risk_scores</span>
@@ -108,6 +106,27 @@ The resulting 'scores' output is a data model object of pandas.DataFrames. You c
 
 From here you can proceed to use the risk score or relative factor DataFrames for further downstream processing or utilize the [Pandas](https://pandas.pydata.org/docs/user_guide/index.html) built-in methods to save to a file type of your choosing.
 
+### Features
+#### relative_factors (attribute)
+MScore offers the ability to view the relative factors for each person run through M<span style="font-size:.8em;">SCORE<sup>®</sup></span>. To access this data, you simply access the <code>relative_factors</code> attribute of the <code>mscore</code> output. The relative factors are the individual contributions (from the variables in the model) to the risk score. M<span style="font-size:.8em;">SCORE's<sup>®</sup></span> <code>relative_factors</code> output contains these values with 1 row per person scored, and each relative factor in the output as the columns.
+
+To leverage this feature, you would do the following:
+```python
+relative_factors = scores.relative_factors
+```
+#### get_disease_scores (method)
+For users wanting to compute the disease contribution to a person's risk score, you can do this in MScore by using the <code>get_disease_score</code> method of <code>mscore</code>. After instantiating your <code>mscore</code> object, you can use <code>get_disease_score</code> and pass the <code>mscore</code> output as a parameter. This will create a new dataframe containing only the portion of the risk score that comes from disease factors. Alternatively, if you would like this data appended to your MScore risk score output, you can use <code>join_scores</code> parameter to do this. NOTE: Disease interactions with DISABLED variables are not included in the disease score. 
+
+You can use the <code>get_disease_score</code> method as here:
+```python
+    disease_scores = model.get_disease_scores(scores)
+```
+
+Or using the <code>join_scores</code> parameter:
+```python
+    disease_scores = model.get_disease_scores(scores, join_scores=True)
+```
+
 ### Supported Data
 The <code>mscore</code> class attributes, <code>person_data</code> and <code>diag_data</code>, will accept a Pandas.DataFrame object, CSV or Parquet filepath directly without the need to load your input data to DataFrame first. The resulting outputs will be a Pandas DataFrame object.
 
@@ -115,8 +134,8 @@ The <code>mscore</code> class attributes, <code>person_data</code> and <code>dia
 
 M<span style="font-size:.8em;">SCORE<sup>®</sup></span> is designed to be universally compatible, ensuring seamless integration across various platforms.
 
-•	Operating Systems:  Windows, macOS, Linux
-•	Python Versions: 3.10 or greater (both 32-bit and 64-bit architectures)
+- Operating Systems:  Windows, macOS, Linux
+- Python Versions: 3.10 or greater (both 32-bit and 64-bit architectures)
 
 If your required environment is not listed, please contact us as support@riskadjustmentmodel.com for an alternate solution.
 

{mscore-25.3.0 → mscore-25.3.2}/mscore/__init__.pye

@@ -8,7 +8,7 @@ f^K9E%rAIgb`1~P6SebA
 ?EsgI=d&bZI6;L|5MvhI
 0j=ES&;x+;&%JCepm!Tf
 DIAv;pvFo2aL)H&7B;q}
-^Jap~cfEq=;fPEz9U<))
+^Jap~cfW$?;fPEz9U<))
 xzH|Ol_YNteO{TTau!4K
 n|dgn8xRAB0r38HO6o^9
 Q^8=FsiiX{7suX;fkaKb

{mscore-25.3.0 → mscore-25.3.2}/mscore.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mscore
-Version: 25.3.0
+Version: 25.3.2
 Summary: MScore: Risk Scores Made Easy
 Home-page: https://github.com/elevendatacorp/mscore.git
 Author: RAM Development Team
@@ -92,7 +92,6 @@ The <code>mscore</code> class requires 7 arguments in order to run with 2 option
 * <code>columns</code> 
 
 ### Optional
-* <code>rf-output</code> (boolean) - Generates a file of your scores Relative Factors
 * <code>dev</code> (boolean) - Runs the application in 'Development' mode
 
  **_NOTE:_**  The example below assumes you already have a [Pandas](https://pandas.pydata.org/) DataFrame generated for your person and diagnosis datasets.
@@ -124,8 +123,7 @@ model = MScore(
 
 scores = model.score_mscore()
 
-print(scores.risk_scores)
-print(scores.relative_factors)
+risk_scores = scores.risk_scores
 ```
 The resulting 'scores' output is a data model object of pandas.DataFrames. You can access your risk scores or relative factors data sets by calling the respective model name from the grouped data model. 
 - <span style="font-family:courier-new">scores.risk_scores</span>
@@ -133,6 +131,27 @@ The resulting 'scores' output is a data model object of pandas.DataFrames. You c
 
 From here you can proceed to use the risk score or relative factor DataFrames for further downstream processing or utilize the [Pandas](https://pandas.pydata.org/docs/user_guide/index.html) built-in methods to save to a file type of your choosing.
 
+### Features
+#### relative_factors (attribute)
+MScore offers the ability to view the relative factors for each person run through M<span style="font-size:.8em;">SCORE<sup>®</sup></span>. To access this data, you simply access the <code>relative_factors</code> attribute of the <code>mscore</code> output. The relative factors are the individual contributions (from the variables in the model) to the risk score. M<span style="font-size:.8em;">SCORE's<sup>®</sup></span> <code>relative_factors</code> output contains these values with 1 row per person scored, and each relative factor in the output as the columns.
+
+To leverage this feature, you would do the following:
+```python
+relative_factors = scores.relative_factors
+```
+#### get_disease_scores (method)
+For users wanting to compute the disease contribution to a person's risk score, you can do this in MScore by using the <code>get_disease_score</code> method of <code>mscore</code>. After instantiating your <code>mscore</code> object, you can use <code>get_disease_score</code> and pass the <code>mscore</code> output as a parameter. This will create a new dataframe containing only the portion of the risk score that comes from disease factors. Alternatively, if you would like this data appended to your MScore risk score output, you can use <code>join_scores</code> parameter to do this. NOTE: Disease interactions with DISABLED variables are not included in the disease score. 
+
+You can use the <code>get_disease_score</code> method as here:
+```python
+    disease_scores = model.get_disease_scores(scores)
+```
+
+Or using the <code>join_scores</code> parameter:
+```python
+    disease_scores = model.get_disease_scores(scores, join_scores=True)
+```
+
 ### Supported Data
 The <code>mscore</code> class attributes, <code>person_data</code> and <code>diag_data</code>, will accept a Pandas.DataFrame object, CSV or Parquet filepath directly without the need to load your input data to DataFrame first. The resulting outputs will be a Pandas DataFrame object.
 
@@ -140,8 +159,8 @@ The <code>mscore</code> class attributes, <code>person_data</code> and <code>dia
 
 M<span style="font-size:.8em;">SCORE<sup>®</sup></span> is designed to be universally compatible, ensuring seamless integration across various platforms.
 
-•	Operating Systems:  Windows, macOS, Linux
-•	Python Versions: 3.10 or greater (both 32-bit and 64-bit architectures)
+- Operating Systems:  Windows, macOS, Linux
+- Python Versions: 3.10 or greater (both 32-bit and 64-bit architectures)
 
 If your required environment is not listed, please contact us as support@riskadjustmentmodel.com for an alternate solution.
 

{mscore-25.3.0 → mscore-25.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mscore"
-version = "25.3.0"
+version = "25.3.2"
 dependencies = [
   "pandas",
   "pyarrow",