Metadata-Version: 2.1
Name: singletCode
Version: 1.0.0
Summary: singletCode is a package to identify true singlets in lineage-barcoded sequencing data.
Author-email: Ziyang Zhang <ziyang.zhang1@northwestern.edu>
Maintainer-email: Keerthana M Arun <keerthana.melekotearun@northwestern.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2023 Goyal Lab
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Homepage, https://goyallab.github.io/SingletCodeWebsite/
Project-URL: Documentation, https://goyallab.github.io/SingletCodeWebsite/packageDocumentation/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scipy>=1.1.0
Requires-Dist: pandas>=0.23.4
Requires-Dist: tqdm>=4.28.1
Requires-Dist: matplotlib>=3.0.2

# singletCode 

singletCode is a framework designed to identify true singlets in barcoded sequencing datasets. It utilizes a CSV file containing cell ID, barcode, and sample name to detect singlets within the dataset.

## Getting Started

For detailed instructions on how to use SingletCode, including setup, input file formats, and execution commands, please visit our [documentation](https://goyallab.github.io/SingletCodeWebsite/packageDocumentation/).

## Features

- **Singlet Identification**: Efficiently identifies true singlets from barcoded sequencing data.
- **Easy Input**: Works with a simple CSV file format that includes cell ID, barcode, and sample name.
- **Comprehensive Documentation**: Detailed guides and usage instructions available.

## Installation

To install SingletCode, ensure that you have a compatible Python environment. For installation instructions, dependencies, and more, refer to the [SingletCode documentation](https://goyallab.github.io/SingletCodeWebsite/packageDocumentation/).

## Usage

After installation, you can run SingletCode with your dataset by following the detailed usage instructions available in our [documentation](https://goyallab.github.io/SingletCodeWebsite/packageDocumentation/).

## Contributing

We welcome contributions to the SingletCode project! If you have suggestions, bug reports, or contributions, please visit our repository's issues section or submit a pull request.

## License

SingletCode is made available under a standard open-source license. For more details, see the LICENSE file in the repository.

For more information about how singletCode works and using it for your sequencing data, please visit [SingletCode's homepage](https://goyallab.github.io/SingletCodeWebsite/).
