diff --git a/docs/candi_module.pdf b/docs/candi_module.pdf deleted file mode 100644 index dead4e8..0000000 Binary files a/docs/candi_module.pdf and /dev/null differ diff --git a/docs/source/CanDI.rst b/docs/source/CanDI.rst index 4b940af..632daa1 100644 --- a/docs/source/CanDI.rst +++ b/docs/source/CanDI.rst @@ -5,9 +5,7 @@ The CanDI data integrator is a python library built on top of the Pandas that is - The Cancer Dependency Map - The Cancer Cell Line Encyclopedia - The Comprehensive Resource of Mammalian Protein Complexes (CORUM) -- Protein localization data from The Cell Atlas -- The Map of the Cell -- The In Silico Surfaceome +- Protein Localization Data from: The Cell Atlas, Map of the Cell, and The In Silico Surfaceome. Access to all datasets is controlled via a python class called Data. Upon import the data class reads the config file established during installation and defines unique paths to each dataset and automatically loads the cell line index table and the gene index table. Installation of CanDI, configuration, and data retrieval is handled by a manager class that is accessed indirectly through installation scripts and the Data class. @@ -19,12 +17,20 @@ The biologically relevant abstraction classes (Gene, CellLine, Cancer, Organelle CanDI.candi module ------------------ -`Link to candi_module.pdf file `_ -.. automodule:: CanDI.candi.candi +User facing CanDI classes (Gene, CellLine, Organelle, Cancer, GeneCluster, CellLineCluster) all inherit from a parent Entity Class. + +.. automodule:: CanDI.structures.entity :members: :undoc-members: :show-inheritance: +The following are the main CanDI classes. These are what users will use to access and cross reference data. + +.. automodule:: CanDI.candi.candi + :members: Gene, CellLine, Organelle, Cancer, CellLineCluster, GeneCluster + :undoc-members: SubsetHandler + :show-inheritance: Gene, CellLine, Organelle, Cancer, CellLineCluster, GeneCluster + CanDI.data module ------------------ The data class is instantiated at import. This class contains paths to all data downloaded with CanDI. diff --git a/docs/source/_static/imgs/structure.pdf b/docs/source/_static/imgs/structure.pdf index 0d28d71..be37c5e 100644 Binary files a/docs/source/_static/imgs/structure.pdf and b/docs/source/_static/imgs/structure.pdf differ diff --git a/docs/source/_static/imgs/structure.png b/docs/source/_static/imgs/structure.png index c6ce5b8..432d5eb 100644 Binary files a/docs/source/_static/imgs/structure.png and b/docs/source/_static/imgs/structure.png differ