Merge pull request #20 from DiogoRibeiro7/feat/first_commit

feat(docs): document generic interface `generate()` and update examples

Author: DiogoRibeiro7

README.md

@@ -39,6 +39,21 @@ df = gen_cphm(
 print(df.head())
 ```
 
+```python
+from gen_surv import generate
+
+df = generate(
+    model="cphm",
+    n=100,
+    model_cens="uniform",
+    cens_par=1.0,
+    beta=0.5,
+    covar=2.0
+)
+
+print(df.head())
+```
+
 ## 🔧 Available Generators
 
 | Function     | Description                                |

docs/source/gen_surv.rst

@@ -30,6 +30,21 @@ df = gen_cphm(n=100, model_cens="uniform", cens_par=1.0, beta=0.5, covar=2.0)
 print(df.head())
 ```
 
+```python
+from gen_surv import generate
+
+df = generate(
+    model="cphm",
+    n=100,
+    model_cens="uniform",
+    cens_par=1.0,
+    beta=0.5,
+    covar=2.0
+)
+
+print(df.head())
+```
+
 ## 🔗 Project Links
 
 - [Source Code](https://github.com/DiogoRibeiro7/genSurvPy)

docs/source/index.md

@@ -16,6 +16,11 @@
       undoc-members: true
 
 ::: gen_surv.thmm
+    options:
+      members: true
+      undoc-members: true
+
+::: gen_surv.interface
     options:
       members: true
       undoc-members: true

docs/source/modules.md

@@ -0,0 +1 @@
+from .interface import generate as generate

gen_surv-stubs/gen_surv/__init__.pyi

@@ -0,0 +1,6 @@
+from gen_surv.cmm import gen_cmm as gen_cmm
+from gen_surv.cphm import gen_cphm as gen_cphm
+from gen_surv.tdcm import gen_tdcm as gen_tdcm
+from gen_surv.thmm import gen_thmm as gen_thmm
+
+def run_example(model: str): ...

gen_surv-stubs/gen_surv/__main__.pyi

@@ -0,0 +1 @@
+def sample_bivariate_distribution(n, dist, corr, dist_par): ...

gen_surv-stubs/gen_surv/bivariate.pyi

@@ -0,0 +1,6 @@
+from gen_surv.cmm import gen_cmm as gen_cmm
+from gen_surv.cphm import gen_cphm as gen_cphm
+from gen_surv.tdcm import gen_tdcm as gen_tdcm
+from gen_surv.thmm import gen_thmm as gen_thmm
+
+def generate(model: str, **kwargs): ...

gen_surv-stubs/gen_surv/interface.pyi

@@ -1,3 +1,4 @@
+from gen_surv.bivariate import sample_bivariate_distribution as sample_bivariate_distribution
 from gen_surv.censoring import rexpocens as rexpocens, runifcens as runifcens
 from gen_surv.validate import validate_gen_tdcm_inputs as validate_gen_tdcm_inputs
 

gen_surv-stubs/gen_surv/tdcm.pyi

@@ -2,3 +2,4 @@ def validate_gen_cphm_inputs(n: int, model_cens: str, cens_par: float, covar: fl
 def validate_gen_cmm_inputs(n: int, model_cens: str, cens_par: float, beta: list, covar: float, rate: list): ...
 def validate_gen_tdcm_inputs(n: int, dist: str, corr: float, dist_par: list, model_cens: str, cens_par: float, beta: list, lam: float): ...
 def validate_gen_thmm_inputs(n: int, model_cens: str, cens_par: float, beta: list, covar: float, rate: list): ...
+def validate_dg_biv_inputs(n: int, dist: str, corr: float, dist_par: list): ...