modamix 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
modamix-0.0.1/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 cbi-bioinfo
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
modamix-0.0.1/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.4
2
+ Name: modamix
3
+ Version: 0.0.1
4
+ Summary: A Unified Framework for Correcting Batch Effects and Integrating Multi-Omics Data
5
+ Home-page: https://github.com/cbi-bioinfo/MoDAmix
6
+ Author: miniymay
7
+ Author-email: joungmin@vt.edu
8
+ Keywords: modamix
9
+ Classifier: Programming Language :: Python :: 3.6
10
+ Classifier: Programming Language :: Python :: 3.7
11
+ Classifier: Programming Language :: Python :: 3.8
12
+ Classifier: Programming Language :: Python :: 3.9
13
+ Requires-Python: >=3.6
14
+ License-File: LICENSE
15
+ Requires-Dist: torch
16
+ Requires-Dist: pandas
17
+ Requires-Dist: os
18
+ Requires-Dist: numpy
19
+ Requires-Dist: sys
20
+ Dynamic: author
21
+ Dynamic: author-email
22
+ Dynamic: classifier
23
+ Dynamic: home-page
24
+ Dynamic: keywords
25
+ Dynamic: license-file
26
+ Dynamic: requires-dist
27
+ Dynamic: requires-python
28
+ Dynamic: summary
@@ -0,0 +1,59 @@
1
+ # MoDAmix
2
+ A Unified Framework for Correcting Batch Effects and Integrating Multi-Omics Data
3
+
4
+ ## Requirements
5
+ * Python (>= 3.6)
6
+ * Pytorch (>= v1.6.0)
7
+ * Other python packages : numpy (>=1.19.1), pandas (>=1.1.1), os, sys, random
8
+
9
+ ## Usage
10
+ Clone the repository or download source code files.
11
+
12
+ ## Inputs
13
+ [Note!] All the example datasets can be found in './example_data/' directory.
14
+
15
+ ### 1. Source multi-omics dataset
16
+ * First omics profiles to be used as source domain (**Source_omics1_X, Source_omics2_X**)
17
+ - Row : Sample, Column : Feature
18
+ - The first column should have "sample id", and the first row should contain the feature names
19
+ - Samples should be sorted in the same order for both omics 1 and omics 2 profiles
20
+ - Example : ./example_data/source_omics1_example_X.csv, source_omics12_example_X.csv
21
+ * Integer-converted subtype label for the source dataset (**Source_Y**)
22
+ - The column name should be "subtype", and the rows should be sorted in the same way as the ones in "Source_omics1_X".
23
+ - The subtype label should start from 0
24
+ - Example : ./example_data/source_example_y.csv
25
+
26
+ ### 2. Target multi-omics dataset
27
+ * Unlabeled multi-omics profiles to be used as target domain (**Target_omics1_X, Target_omics2_X**)
28
+ - Row : Sample, Column : Feature
29
+ - The first column should have "sample_id" and the last two coulmns shoud be "batch" and "domain_idx" which contain the batch name (string) and integer number (index) discriminating each dataset. Samples in the same dataset should have same number and "domain_idx" should start from 1. You can have multiple batch inside.
30
+ - The first row should contain the feature names.
31
+ - Samples should be sorted in the same order for both omics 1 and omics 2 profiles and batch number should be also same for both omics profiles. For example, if you set "batch_A" as 1 for "domain_idx" in omics 1 profiles, then "batch_A" should have same number 1 as "domian_idx" in omics 2 profiles.
32
+ - Example : ./example_data/target_omics1_example_X.csv, target_omics2_example_X.csv
33
+
34
+ ### 3. Meta data
35
+ * Category information
36
+ - This information will be used to convert each integer subtype label with the acutual category name (e.g., cell type, cancer subtype) and provide the prediction result for targe dataset.
37
+ - This file should have two columns named with "subtype" and "subtype_int", which indicate the actual subtype name and the integer-converted subtype label you provided in "Source_Y".
38
+ - Example : ./example_data/subtype_category_info.csv
39
+
40
+ * Batch information
41
+ - This information will be used to convert each batch integer index with the acutual batch name and provide the prediction result for targe dataset.
42
+ - This file should have two columns named with "batch" and "domain_idx", which indicate the actual batch name and the integer-converted batch index you provided in "Target_omics1_X".
43
+ - Example : ./example_data/batch_category_info.csv
44
+
45
+ ## How to run (Example)
46
+ 1. Clone the respository, move to the cloned directory, and edit the **run_MoDAmix.sh** to make sure each variable indicate the corresponding files.
47
+ 2. Run the below command :
48
+ ```
49
+ chmod +x run_MoDAmix.sh
50
+ ./run_MoDAmix.sh
51
+ ```
52
+ If you clone the directory and run the above command directly, you will get the result for the example dataset.
53
+
54
+ 3. All the results will be saved in the newly created **results** directory.
55
+ * batch_corrected features.csv : multi-omics integrated batch corrected features for both source and target dataset
56
+ * results_target_prediction.csv : predicted subtype label for each sample in target dataset
57
+
58
+ ## Contact
59
+ If you have any questions or problems, please contact to joungmin AT vt.edu
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.4
2
+ Name: modamix
3
+ Version: 0.0.1
4
+ Summary: A Unified Framework for Correcting Batch Effects and Integrating Multi-Omics Data
5
+ Home-page: https://github.com/cbi-bioinfo/MoDAmix
6
+ Author: miniymay
7
+ Author-email: joungmin@vt.edu
8
+ Keywords: modamix
9
+ Classifier: Programming Language :: Python :: 3.6
10
+ Classifier: Programming Language :: Python :: 3.7
11
+ Classifier: Programming Language :: Python :: 3.8
12
+ Classifier: Programming Language :: Python :: 3.9
13
+ Requires-Python: >=3.6
14
+ License-File: LICENSE
15
+ Requires-Dist: torch
16
+ Requires-Dist: pandas
17
+ Requires-Dist: os
18
+ Requires-Dist: numpy
19
+ Requires-Dist: sys
20
+ Dynamic: author
21
+ Dynamic: author-email
22
+ Dynamic: classifier
23
+ Dynamic: home-page
24
+ Dynamic: keywords
25
+ Dynamic: license-file
26
+ Dynamic: requires-dist
27
+ Dynamic: requires-python
28
+ Dynamic: summary
@@ -0,0 +1,9 @@
1
+ LICENSE
2
+ README.md
3
+ setup.py
4
+ modamix.egg-info/PKG-INFO
5
+ modamix.egg-info/SOURCES.txt
6
+ modamix.egg-info/dependency_links.txt
7
+ modamix.egg-info/not-zip-safe
8
+ modamix.egg-info/requires.txt
9
+ modamix.egg-info/top_level.txt
@@ -0,0 +1,5 @@
1
+ torch
2
+ pandas
3
+ os
4
+ numpy
5
+ sys
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
modamix-0.0.1/setup.py ADDED
@@ -0,0 +1,22 @@
1
+ from setuptools import setup, find_packages
2
+
3
+ setup(
4
+ name='modamix',
5
+ version='0.0.1',
6
+ description='A Unified Framework for Correcting Batch Effects and Integrating Multi-Omics Data',
7
+ author='miniymay',
8
+ author_email='joungmin@vt.edu',
9
+ url='https://github.com/cbi-bioinfo/MoDAmix',
10
+ install_requires=['torch', 'pandas', 'os', 'numpy', 'sys',],
11
+ packages=find_packages(exclude=[]),
12
+ keywords=['modamix'],
13
+ python_requires='>=3.6',
14
+ package_data={},
15
+ zip_safe=False,
16
+ classifiers=[
17
+ 'Programming Language :: Python :: 3.6',
18
+ 'Programming Language :: Python :: 3.7',
19
+ 'Programming Language :: Python :: 3.8',
20
+ 'Programming Language :: Python :: 3.9',
21
+ ],
22
+ )