add calclib to docs

Author: nebfield

docs/conf.py

@@ -29,6 +29,7 @@
 autoapi_dirs = [
     "../pgscatalog.corelib/src/pgscatalog",
     "../pgscatalog.matchlib/src/pgscatalog",
+    "../pgscatalog.calclib/src/pgscatalog",
 ]
 # see _templates/autoapi/index.rst for autoapi fix
 autoapi_template_dir = "_templates/autoapi"

pgscatalog.calclib/src/pgscatalog/calclib/__init__.py

@@ -0,0 +1,3 @@
+from .polygenicscore import PolygenicScore
+
+__all__ = ["PolygenicScore"]

pgscatalog.calclib/src/pgscatalog/calclib/polygenicscore.py

@@ -65,6 +65,7 @@ def __repr__(self):
         return f"{type(self).__name__}(sampleset={repr(self.sampleset)}, path={repr(self.path)}, df={df})"
 
     def read(self):
+        """Read a PGS file as a pandas dataframe"""
         if self.df is None:
             df = (
                 pd.read_table(self.path)
@@ -86,6 +87,7 @@ def average(self):
         return self.df
 
     def write(self, outdir, split=False):
+        """Write a PGS to a compressed TSV"""
         outdir = pathlib.Path(outdir)
         if split:
             for sampleset, group in self.df.groupby("sampleset"):