|
|
@@ -34,7 +34,7 @@ Note that this strategy is currently only available for `hg19`, `hg38`, `mm9` an
|
|
|
|
|
|
### Introduction of Calder analysis for other genomes
|
|
|
|
|
|
-Although Calder was mainly tested on human and mouse dataset, it can be appliabled on dataset from other genomes.
|
|
|
+Although Calder was mainly tested on human and mouse dataset, it can be appliabled on dataset from other genomes. One additional information is required in such case: a `feature_track`
|
|
|
|
|
|
# Installation
|
|
|
|
|
|
@@ -132,8 +132,8 @@ CALDER_sub_domains(intermediate_data_file,
|
|
|
| **contact_file_dump** |A list of contact files in dump format, named by `chrs`. Each contact file stores the contact information of the corresponding `chr`. Only one of `contact_file_dump`, `contact_tab_dump`, `contact_file_hic` should be provided
|
|
|
| **contact_tab_dump** | A list of contact table in dump format, named by `chrs`, stored as an R object. Only one of `contact_file_dump`, `contact_tab_dump`, `contact_file_hic` should be provided
|
|
|
| **contact_file_hic** | A hic file generated by Juicer tools. It should contain all chromosomes in `chrs`. Only one of `contact_file_dump`, `contact_tab_dump`, `contact_file_hic` should be provided
|
|
|
-| **ref_genome** | One of 'hg19', 'hg38', 'mm9', 'mm10', 'others' (default). These compartments will be used as reference compartments for optimized bin_size selection. If `ref_genome = others`, an `annotation_track` should be provided (see below) and no optimized bin_size selection will be performed
|
|
|
-| **annotation_track** | A genomic annotation track in `data.frame` or `data.table` format. This track will be used for determing the A/B compartment direction when `ref_genome=others` and should presumably have higher values in A than in B compartment. Some suggested tracks can be gene density, H3K27ac, H3K4me1, H3K4me2, H3K4me3, H3K36me3 (or negative transform of H3K9me3 signals)
|
|
|
+| **ref_genome** | One of 'hg19', 'hg38', 'mm9', 'mm10', 'others' (default). These compartments will be used as reference compartments for optimized bin_size selection. If `ref_genome = others`, a `feature_track` should be provided (see below) and no optimized bin_size selection will be performed
|
|
|
+| **feature_track** | A genomic annotation track in `data.frame` or `data.table` format. This track will be used for determing the A/B compartment direction when `ref_genome=others` and should presumably have higher values in A than in B compartment. Some suggested tracks can be gene density, H3K27ac, H3K4me1, H3K4me2, H3K4me3, H3K36me3 (or negative transform of H3K9me3 signals)
|
|
|
| **bin_size** | The bin_size (resolution) to run CALDER. `bin_size` should be consistent with the data resolution in `contact_file_dump` or `contact_tab_dump` if these files are provided as input, otherwise `bin_size` should exist in the `contact_file_hic` file. Recommended `bin_size` is between 10000 to 50000
|
|
|
| **save_dir** | the directory to save outputs
|
|
|
| **save_intermediate_data** | logical. If TRUE, an intermediate_data will be saved. This file can be used for computing nested sub-domains later on
|
Yuanlong LIU