Browse Source

Update README.md

Yuanlong LIU 2 năm trước cách đây
mục cha
commit
b2f3045d59
1 tập tin đã thay đổi với 1 bổ sung1 xóa
  1. 1 1
      README.md

+ 1 - 1
README.md

@@ -119,7 +119,7 @@ CALDER_sub_domains(intermediate_data_file,
 | **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). High quality compartment calls were generated for 'hg19' (hic data from GSE63525), 'hg38' (hic data from https://data.4dnucleome.org/files-processed/4DNFI1UEG1HD/), 'mm9' (hic data from GSM3959427), 'mm10' (hic data from http://hicfiles.s3.amazonaws.com/external/bonev/CN_mapq30.hic). 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)
-| **bin_size**         | numeric, the size of a bin in consistent with the contact table
+| **bin_size**         | the bin_size (resolution) for the analysis. `bin_size` should be consistent with `contact_file_dump` or `contact_tab_dump` when these files were provided as input, otherwise `bin_size` should exist in the `contact_file_hic` file
 | **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
 | **n_cores**     |  integer. Number of cores to be registered for running CALDER in parallel