Fix version mismatch and refine CLI docs

Author: DiogoRibeiro7

CITATION.cff

@@ -5,7 +5,7 @@ message: "If you use this software, please cite it using the metadata below."
 preferred-citation:
   type: software
   title: "gen_surv"
-  version: "1.0.1"
+  version: "1.0.0"
   url: "https://github.com/DiogoRibeiro7/genSurvPy"
   authors:
     - family-names: Ribeiro

gen_surv/cli.py

@@ -7,11 +7,24 @@
 
 @app.command()
 def dataset(
-    model: str = typer.Argument(..., help="Model to simulate [cphm, cmm, tdcm, thmm, aft_ln]"),
+    model: str = typer.Argument(
+        ..., help="Model to simulate [cphm, cmm, tdcm, thmm, aft_ln]"
+    ),
     n: int = typer.Option(100, help="Number of samples"),
-    output: Optional[str] = typer.Option(None, "-o", help="Output CSV file. Prints to stdout if omitted."),
-):
-    """Generate survival data and optionally save to CSV."""
+    output: Optional[str] = typer.Option(
+        None, "-o", help="Output CSV file. Prints to stdout if omitted."
+    ),
+) -> None:
+    """Generate survival data and optionally save to CSV.
+
+    Args:
+        model: Identifier of the generator to use.
+        n: Number of samples to create.
+        output: Optional path to save the CSV file.
+
+    Returns:
+        None
+    """
     df = generate(model=model, n=n)
     if output:
         df.to_csv(output, index=False)

gen_surv/interface.py

@@ -6,6 +6,9 @@
     >>> df = generate(model="cphm", n=100, model_cens="uniform", cens_par=1.0, beta=0.5, covar=2.0)
 """
 
+from typing import Any
+import pandas as pd
+
 from gen_surv.cphm import gen_cphm
 from gen_surv.cmm import gen_cmm
 from gen_surv.tdcm import gen_tdcm
@@ -22,13 +25,13 @@
 }
 
 
-def generate(model: str, **kwargs):
-    """
-    Generic interface to generate survival data from various models.
+def generate(model: str, **kwargs: Any) -> pd.DataFrame:
+    """Generate survival data from a specific model.
 
-    Parameters:
-        model (str): One of ["cphm", "cmm", "tdcm", "thmm"]
-        **kwargs: Arguments forwarded to the selected model generator.
+    Args:
+        model: Name of the generator to run. Must be one of ``cphm``, ``cmm``,
+            ``tdcm``, ``thmm`` or ``aft_ln``.
+        **kwargs: Arguments forwarded to the chosen generator.
 
     Returns:
         pd.DataFrame: Simulated survival data.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gen_surv"
-version = "1.0.1"
+version = "1.0.0"
 description = "A Python package for simulating survival data, inspired by the R package genSurv"
 authors = ["Diogo Ribeiro <[email protected]>"]
 license = "MIT"