Skip to content

Commit 49ec173

Browse files
author
lev
committed
README.rst: updated to reflect set_io package
1 parent 1ec2069 commit 49ec173

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ Subpackages included
8282

8383
* **cmap_api_client**: A Python API client for accessing and retrieving information from the `Connectivity Map API <https://clue.io/api>`_
8484

85+
* **set_io**: Parserts and writers for .grp and .gmt files.
86+
8587
***************
8688
1) pandasGEXpress
8789
***************
@@ -93,7 +95,6 @@ pandasGEXpress represents .gctx and .gct files as instances of a GCToo object; i
9395
* ``GCToo.py``: main class for storing contents of .gctx, .gct files.
9496
* ``concat_gctoo.py``: Concatenate (horizontally or vertically) two or more GCToo instances in a Python session or two {.gct, .gctx} files from the command line.
9597
* ``parse.py``: Parse in .gct, .gctx files to a new GCToo instance
96-
* ``plate_grp.py``: Read and write .grp files to a list.
9798
* ``random_slice.py``: Slices a random subset of a GCToo file to a specified size.
9899
* ``slice_gct.py``: Slice a GCToo instance by including/excluding a list of row ids, column ids, row indexes, column indexes, or a combination thereof.
99100
* ``write_gct.py``: Write a .gct file from a GCToo instance.
@@ -126,7 +127,18 @@ Contents Overview
126127
* ``gene_queries.py``: Methods for gene-related queries.
127128
* ``macchiato_queries.py``: Methods for brew_prefix related queries.
128129
* ``mock_clue_api_client.py``: Mock API for testing.
129-
* ``pert_queries.py``: Methods for perturbagen-related queries.
130+
* ``pert_queries.py``: Methods for perturbagen-related queries.
131+
132+
***************
133+
3) set_io
134+
***************
135+
136+
set_io contains simple scripts for parsing two other common file types used by the Connectivity Map: `GRP and GMT files. <https://clue.io/connectopedia/grp_gmt_gmx_format>`_ The GRP file is used for storing a single set of things (e.g. a single gene set), while the GMT file is used for storing multiple sets of things (e.g. several gene sets).
137+
138+
Contents Overview
139+
"""""""""""""""""
140+
* ``grp.py``: Read and write .grp files to a list.
141+
* ``gmt.py``: Read and write .gmt files to a list of dictionaries.
130142

131143
Tutorials and example use
132144
"""""""""""""""""""""""""

0 commit comments

Comments
 (0)