Rebase from before REMOVE

breimanntools · Sep 20, 2023 · d08e96c · d08e96c
1 parent 279db56
commit d08e96c
Show file tree

Hide file tree

Showing 133 changed files with 5,856 additions and 23 deletions.
diff --git a/aaanalysis/aaclust/__pycache__/__init__.cpython-39.pyc b/aaanalysis/aaclust/__pycache__/__init__.cpython-39.pyc
diff --git a/aaanalysis/aaclust/__pycache__/aaclust.cpython-39.pyc b/aaanalysis/aaclust/__pycache__/aaclust.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/__init__.cpython-39.pyc b/aaanalysis/cpp/__pycache__/__init__.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/_cpp.cpython-39.pyc b/aaanalysis/cpp/__pycache__/_cpp.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/_feature_pos.cpython-39.pyc b/aaanalysis/cpp/__pycache__/_feature_pos.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/_feature_stat.cpython-39.pyc b/aaanalysis/cpp/__pycache__/_feature_stat.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/_part.cpython-39.pyc b/aaanalysis/cpp/__pycache__/_part.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/_split.cpython-39.pyc b/aaanalysis/cpp/__pycache__/_split.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/cpp.cpython-39.pyc b/aaanalysis/cpp/__pycache__/cpp.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/cpp_plot.cpython-39.pyc b/aaanalysis/cpp/__pycache__/cpp_plot.cpython-39.pyc
diff --git a/aaanalysis/cpp/__pycache__/feature.cpython-39.pyc b/aaanalysis/cpp/__pycache__/feature.cpython-39.pyc
diff --git a/aaanalysis/data_loader/__pycache__/__init__.cpython-39.pyc b/aaanalysis/data_loader/__pycache__/__init__.cpython-39.pyc
diff --git a/aaanalysis/data_loader/__pycache__/data_loader.cpython-39.pyc b/aaanalysis/data_loader/__pycache__/data_loader.cpython-39.pyc
diff --git a/aaanalysis/dpulearn/__pycache__/__init__.cpython-39.pyc b/aaanalysis/dpulearn/__pycache__/__init__.cpython-39.pyc
diff --git a/aaanalysis/dpulearn/__pycache__/dpulearn.cpython-39.pyc b/aaanalysis/dpulearn/__pycache__/dpulearn.cpython-39.pyc
diff --git a/aaanalysis/plotting/__pycache__/__init__.cpython-39.pyc b/aaanalysis/plotting/__pycache__/__init__.cpython-39.pyc
diff --git a/aaanalysis/plotting/__pycache__/plotting_functions.cpython-39.pyc b/aaanalysis/plotting/__pycache__/plotting_functions.cpython-39.pyc
diff --git a/docs/build/doctrees/_index/tables.doctree b/docs/build/doctrees/_index/tables.doctree
diff --git a/docs/build/doctrees/api.doctree b/docs/build/doctrees/api.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/generated/aaanalysis.AAclust.doctree b/docs/build/doctrees/generated/aaanalysis.AAclust.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.CPP.doctree b/docs/build/doctrees/generated/aaanalysis.CPP.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.CPPPlot.doctree b/docs/build/doctrees/generated/aaanalysis.CPPPlot.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.SequenceFeature.doctree b/docs/build/doctrees/generated/aaanalysis.SequenceFeature.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.dPULearn.doctree b/docs/build/doctrees/generated/aaanalysis.dPULearn.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.load_dataset.doctree b/docs/build/doctrees/generated/aaanalysis.load_dataset.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.load_scales.doctree b/docs/build/doctrees/generated/aaanalysis.load_scales.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.plot_gcfs.doctree b/docs/build/doctrees/generated/aaanalysis.plot_gcfs.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.plot_get_cdict.doctree b/docs/build/doctrees/generated/aaanalysis.plot_get_cdict.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.plot_get_cmap.doctree b/docs/build/doctrees/generated/aaanalysis.plot_get_cmap.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.plot_set_legend.doctree b/docs/build/doctrees/generated/aaanalysis.plot_set_legend.doctree
diff --git a/docs/build/doctrees/generated/aaanalysis.plot_settings.doctree b/docs/build/doctrees/generated/aaanalysis.plot_settings.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/index/tables_template.doctree b/docs/build/doctrees/index/tables_template.doctree
diff --git a/docs/build/doctrees/index/usage_principles.doctree b/docs/build/doctrees/index/usage_principles.doctree
diff --git a/docs/build/doctrees/index/usage_principles/aaontology.doctree b/docs/build/doctrees/index/usage_principles/aaontology.doctree
diff --git a/docs/build/doctrees/index/usage_principles/data_flow_entry_points.doctree b/docs/build/doctrees/index/usage_principles/data_flow_entry_points.doctree
diff --git a/docs/build/doctrees/index/usage_principles/feature_identification.doctree b/docs/build/doctrees/index/usage_principles/feature_identification.doctree
diff --git a/docs/build/doctrees/index/usage_principles/pu_learning.doctree b/docs/build/doctrees/index/usage_principles/pu_learning.doctree
diff --git a/docs/build/doctrees/index/usage_principles/xai.doctree b/docs/build/doctrees/index/usage_principles/xai.doctree
diff --git a/docs/build/html/_downloads/fe02006031f96dc9a3a8b158e5899dae/aaanalysis-CPPPlot-1.py b/docs/build/html/_downloads/fe02006031f96dc9a3a8b158e5899dae/aaanalysis-CPPPlot-1.py
@@ -0,0 +1,6 @@
+import matplotlib.pyplot as plt
+import aaanalysis as aa
+sf = aa.SequenceFeature()
+df_seq = aa.load_dataset(name='SEQ_DISULFIDE', min_len=100)
+labels = list(df_seq["label"])
+df_parts = sf.get_df_parts(df_seq=df_seq, jmd_n_len=10, jmd_c_len=10)
diff --git a/docs/build/html/_images/social_previews/summary__index_tables_9266ddb8.png b/docs/build/html/_images/social_previews/summary__index_tables_9266ddb8.png
diff --git a/.../html/_images/social_previews/summary_generated_aaanalysis.AAclust_20fb7a30.png b/.../html/_images/social_previews/summary_generated_aaanalysis.AAclust_20fb7a30.png
diff --git a/.../html/_images/social_previews/summary_generated_aaanalysis.CPPPlot_5461b2c2.png b/.../html/_images/social_previews/summary_generated_aaanalysis.CPPPlot_5461b2c2.png
diff --git a/...uild/html/_images/social_previews/summary_generated_aaanalysis.CPP_6a66faaa.png b/...uild/html/_images/social_previews/summary_generated_aaanalysis.CPP_6a66faaa.png
diff --git a/...mages/social_previews/summary_generated_aaanalysis.SequenceFeature_6c1c9b33.png b/...mages/social_previews/summary_generated_aaanalysis.SequenceFeature_6c1c9b33.png
diff --git a/...html/_images/social_previews/summary_generated_aaanalysis.dPULearn_44ddb18b.png b/...html/_images/social_previews/summary_generated_aaanalysis.dPULearn_44ddb18b.png
diff --git a/.../_images/social_previews/summary_generated_aaanalysis.load_dataset_c5bd8cb0.png b/.../_images/social_previews/summary_generated_aaanalysis.load_dataset_c5bd8cb0.png
diff --git a/...l/_images/social_previews/summary_generated_aaanalysis.load_scales_65ee1b77.png b/...l/_images/social_previews/summary_generated_aaanalysis.load_scales_65ee1b77.png
diff --git a/...tml/_images/social_previews/summary_generated_aaanalysis.plot_gcfs_c60ff7c4.png b/...tml/_images/social_previews/summary_generated_aaanalysis.plot_gcfs_c60ff7c4.png
diff --git a/...images/social_previews/summary_generated_aaanalysis.plot_get_cdict_7e3963aa.png b/...images/social_previews/summary_generated_aaanalysis.plot_get_cdict_7e3963aa.png
diff --git a/..._images/social_previews/summary_generated_aaanalysis.plot_get_cmap_6e0e4868.png b/..._images/social_previews/summary_generated_aaanalysis.plot_get_cmap_6e0e4868.png
diff --git a/...mages/social_previews/summary_generated_aaanalysis.plot_set_legend_0daa943e.png b/...mages/social_previews/summary_generated_aaanalysis.plot_set_legend_0daa943e.png
diff --git a/..._images/social_previews/summary_generated_aaanalysis.plot_settings_070d72d4.png b/..._images/social_previews/summary_generated_aaanalysis.plot_settings_070d72d4.png
diff --git a/docs/build/html/_images/social_previews/summary_index_08b80e48.png b/docs/build/html/_images/social_previews/summary_index_08b80e48.png
diff --git a/docs/build/html/_images/social_previews/summary_index_8467f51f.png b/docs/build/html/_images/social_previews/summary_index_8467f51f.png
diff --git a/docs/build/html/_images/social_previews/summary_index_tables_template_9266ddb8.png b/docs/build/html/_images/social_previews/summary_index_tables_template_9266ddb8.png
diff --git a/.../build/html/_images/social_previews/summary_index_usage_principles_94300a05.png b/.../build/html/_images/social_previews/summary_index_usage_principles_94300a05.png
diff --git a/.../_images/social_previews/summary_index_usage_principles_aaontology_434210d3.png b/.../_images/social_previews/summary_index_usage_principles_aaontology_434210d3.png
diff --git a/...ial_previews/summary_index_usage_principles_data_flow_entry_points_98e2fab0.png b/...ial_previews/summary_index_usage_principles_data_flow_entry_points_98e2fab0.png
diff --git a/...ial_previews/summary_index_usage_principles_feature_identification_77405e00.png b/...ial_previews/summary_index_usage_principles_feature_identification_77405e00.png
diff --git a/..._images/social_previews/summary_index_usage_principles_pu_learning_9a1def62.png b/..._images/social_previews/summary_index_usage_principles_pu_learning_9a1def62.png
diff --git a/...ld/html/_images/social_previews/summary_index_usage_principles_xai_c236df6c.png b/...ld/html/_images/social_previews/summary_index_usage_principles_xai_c236df6c.png
diff --git a/docs/build/html/_index/tables.html b/docs/build/html/_index/tables.html
diff --git a/docs/build/html/_sources/_index/tables.rst.txt b/docs/build/html/_sources/_index/tables.rst.txt
@@ -0,0 +1,246 @@
+..
+    Developer Notes:
+    This is the index file for all tables of the AAanalysis documentation. Each table should be saved the /tables
+    directory. This file will serve as template for tables.rst, which is automatically created on the information
+    provided here and in the .csv tables from the /tables directory. Add a new table as .csv in the /tables directory,
+    in the overview table at the beginning of this document, and a new section with a short description of it in this
+    document. Each column and important data types (e.g., categories) should be described. Each table should contain a
+    'Reference' column.
+    Ignore 'tables_template.rst: WARNING: document isn't included in any toctree' warning
+
+Tables
+======================
+
+.. contents::
+    :local:
+    :depth: 1
+
+Overview Table
+--------------
+All tables from the AAanalysis documentation are given here in chronological order of the project history.
+
+.. _0_mapper:
+.. list-table::
+   :header-rows: 1
+   :widths: 8 8 8
+
+   * - Table
+     - Description
+     - See also
+   * - 1_overview_benchmarks
+     - Protein benchmark datasets
+     - aa.load_dataset
+   * - 2_overview_scales
+     - Amino acid scale datasets
+     - aa.load_scales
+
+
+Protein benchmark datasets
+--------------------------
+Three types of benchmark datasets are provided:
+
+- Residue prediction (AA): Datasets used to predict residue (amino acid) specific properties.
+- Domain prediction (DOM): Dataset used to predict domain specific properties.
+- Sequence prediction (SEQ): Datasets used to predict sequence specific properties.
+
+The classification of each dataset is indicated as first part of their name followed by an abbreviation for the
+specific dataset (e.g., 'AA_LDR', 'DOM_GSEC', 'SEQ_AMYLO'). For some datasets, an additional version of it is provided
+for positive-unlabeled (PU) learning containing only positive (1) and unlabeled (2) data samples, as indicated by
+*dataset_name_PU* (e.g., 'DOM_GSEC_PU').
+
+.. _1_overview_benchmarks:
+.. list-table::
+   :header-rows: 1
+   :widths: 8 8 8 8 8 8 8 8 8 8
+
+   * - Level
+     - Dataset
+     - # Sequences
+     - # Amino acids
+     - # Positives
+     - # Negatives
+     - Predictor
+     - Description
+     - Reference
+     - Label
+   * - Amino acid
+     - AA_CASPASE3
+     - 233
+     - 185605
+     - 705
+     - 184900
+     - PROSPERous
+     - Prediction of caspase-3 cleavage site
+     - :ref:`Song18 <Song18>`
+     - 1 (adjacent to cleavage site), 0 (not adjacent to cleavage site)
+   * - Amino acid
+     - AA_FURIN
+     - 71
+     - 59003
+     - 163
+     - 58840
+     - PROSPERous
+     - Prediction of furin cleavage site
+     - :ref:`Song18 <Song18>`
+     - 1 (adjacent to cleavage site), 0 (not adjacent to cleavage site)
+   * - Amino acid
+     - AA_LDR
+     - 342
+     - 118248
+     - 35469
+     - 82779
+     - IDP-Seq2Seq
+     - Prediction of long intrinsically disordered regions (LDR)
+     - :ref:`Tang20 <Tang20>`
+     - 1 (disordered), 0 (ordered)
+   * - Amino acid
+     - AA_MMP2
+     - 573
+     - 312976
+     - 2416
+     - 310560
+     - PROSPERous
+     - Prediction of Matrix metallopeptidase-2 (MMP2) cleavage site
+     - :ref:`Song18 <Song18>`
+     - 1 (adjacent to cleavage site), 0 (not adjacent to cleavage site)
+   * - Amino acid
+     - AA_RNABIND
+     - 221
+     - 55001
+     - 6492
+     - 48509
+     - GMKSVM-RU
+     - Prediction of RNA-binding protein residues (RBP60 dataset)
+     - :ref:`Yang21 <Yang21>`
+     - 1 (binding), 0 (non-binding)
+   * - Amino acid
+     - AA_SA
+     - 233
+     - 185605
+     - 101082
+     - 84523
+     - PROSPERous
+     - Prediction of solvent accessibility (SA) of residue (AA_CASPASE3 data set)
+     - :ref:`Song18 <Song18>`
+     - 1 (exposed/accessible), 0 (buried/non-accessible)
+   * - Sequence
+     - SEQ_AMYLO
+     - 1414
+     - 8484
+     - 511
+     - 903
+     - ReRF-Pred
+     - Prediction of amyloidognenic regions
+     - :ref:`Teng21 <Teng21>`
+     - 1 (amyloidogenic), 0 (non-amyloidogenic)
+   * - Sequence
+     - SEQ_CAPSID
+     - 7935
+     - 3364680
+     - 3864
+     - 4071
+     - VIRALpro
+     - Prediction of capdsid proteins
+     - :ref:`Galiez16 <Galiez16>`
+     - 1 (capsid protein), 0 (non-capsid protein)
+   * - Sequence
+     - SEQ_DISULFIDE
+     - 2547
+     - 614470
+     - 897
+     - 1650
+     - Dipro
+     - Prediction of disulfide bridges in sequences
+     - :ref:`Cheng06 <Cheng06>`
+     - 1 (sequence with SS bond), 0 (sequence without SS bond)
+   * - Sequence
+     - SEQ_LOCATION
+     - 1835
+     - 732398
+     - 1045
+     - 790
+     - nan
+     - Prediction of subcellular location of protein (cytoplasm vs plasma membrane)
+     - :ref:`Shen19 <Shen19>`
+     - 1 (protein in cytoplasm), 0 (protein in plasma membrane) 
+   * - Sequence
+     - SEQ_SOLUBLE
+     - 17408
+     - 4432269
+     - 8704
+     - 8704
+     - SOLpro
+     - Prediction of soluble and insoluble proteins
+     - :ref:`Magnan09 <Magnan09>`
+     - 1 (soluble), 0 (insoluble)
+   * - Sequence
+     - SEQ_TAIL
+     - 6668
+     - 2671690
+     - 2574
+     - 4094
+     - VIRALpro
+     - Prediction of tail proteins
+     - :ref:`Galiez16 <Galiez16>`
+     - 1 (tail protein), 0 (non-tail protein)
+   * - Domain
+     - DOM_GSEC
+     - 126
+     - 92964
+     - 63
+     - 63
+     - nan
+     - Prediction of gamma-secretase substrates
+     - :ref:`Breimann23c <Breimann23c>`
+     - 1 (substrate), 0 (non-substrate)
+   * - Domain
+     - DOM_GSEC_PU
+     - 694
+     - 494524
+     - 63
+     - 0
+     - nan
+     - Prediction of gamma-secretase substrates (PU dataset)
+     - :ref:`Breimann23c <Breimann23c>`
+     - 1 (substrate), 2 (unknown substrate status)
+
+
+Amino acid scale datasets
+-------------------------
+Different amino acid scale datasets are provided
+
+.. _2_overview_scales:
+.. list-table::
+   :header-rows: 1
+   :widths: 8 8 8 8
+
+   * - Dataset
+     - Description
+     - # Scales
+     - Reference
+   * - scales
+     - Amino acid scales (min-max normalized)
+     - 586
+     - :ref:`Breimann23b <Breimann23b>`
+   * - scales_raw
+     - Amino acid scales (raw values)
+     - 586
+     - :ref:`Kawashima08 <Kawashima08>`
+   * - scales_classification
+     - Classification of scales (Aaontology)
+     - 586
+     - :ref:`Breimann23b <Breimann23b>`
+   * - scales_pc
+     - Principal component (PC) compressed scales
+     - 20
+     - :ref:`Breimann23a <Breimann23a>`
+   * - top60
+     - Top 60 scale subsets
+     - 60
+     - :ref:`Breimann23a <Breimann23a>`
+   * - top60_eval
+     - Evaluation of top 60 scale subsets
+     - 60
+     - :ref:`Breimann23a <Breimann23a>`
+
+
diff --git a/docs/build/html/_sources/api.rst.txt b/docs/build/html/_sources/api.rst.txt
@@ -21,6 +21,8 @@ Data
 .. autosummary::
     :toctree: generated/
 
+    aaanalysis.load_dataset
+    aaanalysis.load_scales
 
 .. _feature_engineering_api:
 
@@ -29,6 +31,10 @@ Feature Engineering
 .. autosummary::
     :toctree: generated/
 
+    aaanalysis.AAclust
+    aaanalysis.SequenceFeature
+    aaanalysis.CPP
+    aaanalysis.CPPPlot
 
 .. _pu_learning_api:
 
@@ -37,6 +43,7 @@ PU Learning
 .. autosummary::
     :toctree: generated/
 
+    aaanalysis.dPULearn
 
 .. _plot_api:
 
@@ -54,3 +61,9 @@ Plot Utilities
 .. autosummary::
     :toctree: generated/
 
+    aaanalysis.plot_settings
+    aaanalysis.plot_set_legend
+    aaanalysis.plot_gcfs
+    aaanalysis.plot_get_cmap
+    aaanalysis.plot_get_cdict
+
diff --git a/docs/build/html/_sources/generated/aaanalysis.AAclust.rst.txt b/docs/build/html/_sources/generated/aaanalysis.AAclust.rst.txt
@@ -0,0 +1,28 @@
+aaanalysis.AAclust
+==================
+
+.. currentmodule:: aaanalysis
+
+.. autoclass:: AAclust
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~AAclust.__init__
+      ~AAclust.cluster_naming
+      ~AAclust.correlation
+      ~AAclust.eval
+      ~AAclust.fit
+      ~AAclust.get_cluster_centers
+      ~AAclust.get_cluster_medoids
+
+
+
+
+
+
diff --git a/docs/build/html/_sources/generated/aaanalysis.CPP.rst.txt b/docs/build/html/_sources/generated/aaanalysis.CPP.rst.txt
@@ -0,0 +1,24 @@
+aaanalysis.CPP
+==============
+
+.. currentmodule:: aaanalysis
+
+.. autoclass:: CPP
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~CPP.__init__
+      ~CPP.eval
+      ~CPP.run
+
+
+
+
+
+
diff --git a/docs/build/html/_sources/generated/aaanalysis.CPPPlot.rst.txt b/docs/build/html/_sources/generated/aaanalysis.CPPPlot.rst.txt
@@ -0,0 +1,25 @@
+aaanalysis.CPPPlot
+==================
+
+.. currentmodule:: aaanalysis
+
+.. autoclass:: CPPPlot
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~CPPPlot.__init__
+      ~CPPPlot.heatmap
+      ~CPPPlot.profile
+      ~CPPPlot.update_seq_size
+
+
+
+
+
+