Ver Fonte

Update README.md

Yuanlong LIU há 2 anos atrás
pai
commit
aceb7fffa1
1 ficheiros alterados com 23 adições e 21 exclusões
  1. 23 21
      README.md

+ 23 - 21
README.md

@@ -229,29 +229,9 @@ CALDER(contact_file_dump=contact_file_dump,
 | **sub_domains**     |  logical, whether to compute nested sub-domains
 
 
-### Output:
-
-#### chrxx_domain_hierachy.tsv
-* information of compartment domain and their hierarchical organization. The hierarchical structure is fully represented by `compartment_label`, for example, `B.2.2.2` and `B.2.2.1` are two sub-branches of `B.2.2`. The `pos_end` column specifies all compartment domain borders, except when it is marked as `gap`, which indicates it is the border of a gap chromsome region that has too few contacts and was excluded from the analysis (e.g., due to low mappability, deletion, technique flaw) 
-
-#### chrxx_sub_compartments.bed
-* a .bed file containing the sub-compartment information, that can be visualized in IGV. Different colors were used to distinguish compartments (at the resolution of 8 sub-compartments)  
-
-#### chrxx_domain_boundaries.bed
-* a .bed file containing the chromatin domains boundaries, that can be visualized in IGV
-
-#### chrxx_nested_boundaries.bed
-* a .bed file containing the nested sub-domain boundaries, that can be visualized in IGV
-
-#### chrxx_intermediate_data.Rds
-* an Rds file storing the intermediate_data that can be used to compute nested sub-domains (if CALDER is run in two seperated steps)
-
-#### chrxx_log.txt, chrxx_sub_domains_log.txt
-* log file storing the status and running time of each step
-
 
 ## Output Structure
-The output of the workflow is stored in the folder specified by `--save_dir` ("results" by default) and will look like this:
+The output of the workflow is stored in the folder specified by `save_dir` and will look like this:
 ```
 save_dir/
 |-- intermediate_data
@@ -300,6 +280,28 @@ save_dir/
     `-- all_nested_boundaries.bed
 ```
 
+### File description:
+
+#### chrxx_domain_hierachy.tsv
+* information of compartment domain and their hierarchical organization. The hierarchical structure is fully represented by `compartment_label`, for example, `B.2.2.2` and `B.2.2.1` are two sub-branches of `B.2.2`. The `pos_end` column specifies all compartment domain borders, except when it is marked as `gap`, which indicates it is the border of a gap chromsome region that has too few contacts and was excluded from the analysis (e.g., due to low mappability, deletion, technique flaw) 
+
+#### chrxx_sub_compartments.bed
+* a .bed file containing the sub-compartment information, that can be visualized in IGV. Different colors were used to distinguish compartments (at the resolution of 8 sub-compartments)  
+
+#### chrxx_domain_boundaries.bed
+* a .bed file containing the chromatin domains boundaries, that can be visualized in IGV
+
+#### chrxx_nested_boundaries.bed
+* a .bed file containing the nested sub-domain boundaries, that can be visualized in IGV
+
+#### chrxx_intermediate_data.Rds
+* an Rds file storing the intermediate_data that can be used to compute nested sub-domains (if CALDER is run in two seperated steps)
+
+#### chrxx_log.txt, chrxx_sub_domains_log.txt
+* log file storing the status and running time of each step
+
+
+
 The saved .bed files can be view directly through IGV:
 
 ![Alt text](./img/IGV_results.png "IGV")