Skip to main content

README for SMART (1.0.7)

Time-stamp: <2014-08-03 23:28:37 Hongbo Liu>

Introduction

It is known that DNA methylation plays important roles in regulation of cell development and differentiation. DNA methylation/unmethylation mechanisms are common in all tissue/cell. However, different cell types with the same genome have different methylomes. Recently, high-throughput sequencing combining bisulfite treatment (Bisulfite -Seq) have been used to generate DNA methylomes from a wide range of human tissue/cell types at a genome-wide perspective. To characterize the genome regions that consist of continuous CpGs with similar methylation specificity, we developed the Specific Methylation Analysis and Report Tool (SMART) based on the quantified methylation specificity, Euclidean distance and similarity entropy. SMART aims to segment the genome into different functional regions based on the methylation pattern in multiple cell types. Continuous scanning is firstly carried out to obtain the primary segments composed by CpG sites with high methylation similarity across all cell types. Then, the primary segments those localize in close proximity and share similar methylation pattern are merged into different types of segments including high specificity segment (HighSpe), low specificity segment (LowSpe) and almost no cell-specificity segment (NoSpe). At last, the cell-type-specific methylation marks were identified to facilitate the epigenetic analysis.

Install

Please check the file ‘INSTALL’ in the distribution.

Usage of SMART

usage:

SMART MethyDir CytosineDir [-h] [-n PROJECTNAME] [-o OUTPUTFOLDER] [-v]

positional arguments

MethyDir

The directory (such as /liuhb/BSSeq/) of the folder including methylation data files formated in wig.gz (such as H1.wig.gz). REQUIRED.

CytosineDir

The directory (such as /liuhb/CLoc_hg19/) of the folder including cytosine location files for all chromesomes formated in txt.gz (such as chr1.txt.gz). REQUIRED.

optional arguments

-h, –help

show this help message and exit

-n PROJECTNAME

Project name, which will be used to generate output file names. DEFAULT: “SMART”

-o OUTPUTFOLDER

If specified all output files will be written to that directory. Default: the directory named using projectname and currenttime (such as SMART20140801132559) in the current working directory.

-v, –version

show program’s version number and exit

Example

Example data

The example data can be found in the directory Example under the installation directory of SMART. It should be noted that the location of installation directory of SMART may be different in different Operating System. The Cytosines and their methylation level in 50kb regions from chr3 and chr6 were extracted for test of SMART. User can use following command to test SMART.

Example command

For Linux:

The main function SMART may be in /usr/local/bin/, and example data may be in ../python2.7/dist-packages/SMART/Example. The following referece may be useful for test of SMART:

SMART /usr/local/lib/python2.7/dist-packages/SMART/Example/BSSeq_fortest/ /usr/local/lib/python2.7/dist-packages/SMART/Example/CLoc_hg19_fortest/ -n Test -o /usr/local/lib/python2.7/dist-packages/SMART/Example/Example_Results/
For windows:

The main function SMART may be in ..\Python27\Scripts\, and example data may be in ..\Python27\Lib\site-packages\SMART\Example. The following referece may be useful for test of SMART:

cd  ..\Python27\Scripts\
python SMART ..\Python27\Lib\site-packages\SMART\Example\BSSeq_fortest\ ..\Python27\Lib\site-packages\SMART\Example\CLoc_hg19_fortest\ -n Test -o ..\Python27\Lib\site-packages\SMART\Example\Example_Results\

Output Files

  1. Folder SplitedMethy is a a output directory to store the splited Methylation data. The methylation data are stored in different chromosome sub-folders. In each sub-folder, the methylation data for all samples are included.

  2. Folder MethylationSpecificity is a output directory to store the methylation levels and specifity for each C which is common across all samples. These files are stored in chromosomes. In this folder, MethylationSpecificity.wig.gz includes the methylation specifity of all common C. And this file can be uploaded to UCSC browser for visualization.

  3. Folder MethylationSegment includes three sub-folders: GenomeSegment, GenomeSegmentMethy, and MergedGenomeSegment. The sub-folder GenomeSegment stores all small segments identified by SMART in each chromosome. And the sub-folder GenomeSegmentMethy stores the methylation levels of each small segments across all samples which may be useful for users’ local further analysis. The sub-folder MergedGenomeSegment stores the larger segments merged based on the small segments in each chromosome. The final results are generated based on these merged segments.

  4. Folder FinalResults includes all intresting results which may be concerned by users. In this folder, there are six files.

    -The first file 1SmallSegmentBed.txt.gz stores all small segments in bed format, which can be uploaded to UCSC browser for visualization.

    -The second file 2MergedSegmentBed.txt.gz stores all merged segments in bed format, which can be uploaded to UCSC browser for visualization.

    -The third file 3MergedSegment.txt stores all merged segments in txt format, which is useful for local further analysis.

    -The fourth file 4MergedSegmentwithmethylation.txt stores the methylation levels of all merged segments across all samples, which is useful for local further analysis.

    -The fifth file 5MergedHighLowSpeSegmentwithspecificity.txt stores the methylation specificity and p values of t-test for each merged HighSpe/LowSpe segement, which is useful for further analysis on cell-type-specificity for each HighSpe/LowSpe segement. The positive p value represents the segment is hyper-methylated in the corresbonding cell-type, while the negative p value represents the segment is hypo-methylated in the corresbonding cell-type.

    -The sixth file 6CellTypeSpecificMethymarkPvalue.txt is a reformated file for the fifth file. In this file, only the HighSpe/LowSpe segements which show significant hypo- or hyper-methylation in some cell-types are remained. This file is usefull for users to select and analyze cell-type-specific methylation marks including HypoMarks and HyperMarks.

Contact

For any help:

you are welcome to write to Hongbo Liu (hongbo919@gmail.com).

Metadata

Release files for SMART-BS-Seq 1.0.7.20140803

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for SMART-BS-Seq 1.0.7.20140803
File Size Uploaded Provenance Actions
SMART-BS-Seq-1.0.7.20140803.tar.gz 279.9 kB Without provenance Details for SMART-BS-Seq-1.0.7.20140803.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for SMART-BS-Seq 1.0.7.20140803
File Interpreter ABI Platform Actions
SMART-BS-Seq-1.0.7.20140803.win-amd64.exe Details for SMART-BS-Seq-1.0.7.20140803.win-amd64.exe

Total release size: 810.5 kB

Release files / SMART-BS-Seq-1.0.7.20140803.tar.gz

Download URL SMART-BS-Seq-1.0.7.20140803.tar.gz
Size 279.9 kB
Tags Source
SHA-256 checksum
How to use checksums
02e984ac451ccdfb8784519610f78589fdab049bf773f8346195f891237098cb
BLAKE2b-256 checksum
How to use checksums
eddfe1ca3e1ed7821e11bfc19c5b64915efeb5d72119a28d6f82f68603677689
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / SMART-BS-Seq-1.0.7.20140803.win-amd64.exe

Download URL SMART-BS-Seq-1.0.7.20140803.win-amd64.exe
Size 530.6 kB
Tags Source
SHA-256 checksum
How to use checksums
9bc6ac92e4c7fe91aac6f275717754657c3e34ef8a6ecd6dc6438a8fbecedf09
BLAKE2b-256 checksum
How to use checksums
a8e8d0d79ab6fb2852da65118d14009a05c4687dd1346c9f006c459b8a41a0b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for SMART-BS-Seq 1.0.7.20140803

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page