diff --git a/README.md b/README.md index caec1db8..382a86b2 100644 --- a/README.md +++ b/README.md @@ -444,6 +444,7 @@ Here is a table to summarize which are the parameters that can be use for each o Empty means this parameter is not used. not set means that by default the parameter is commented. + parameter | x-axis | epilogos | links | domains | bed | narrow_peak | bigwig | bedgraph | bedgraph_matrix | hlines | hic_matrix -- | - | - | - | - | - | - | - | - | - | - | - where | bottom | | | | | | | | | | @@ -490,12 +491,12 @@ show_masked_bins | | | | | | | | | | | false scale_factor | | | | | | | | | | | 1 transform | | | | | | | | | | | no colormap | | | | | | | | | | | RdYlBu_r - + Some parameters can take only discrete values. They are summarized here: - + - **where**: - for *x-axis*: top, bottom - **orientation**: @@ -542,6 +543,7 @@ They are summarized here: - for *bigwig, bedgraph*: true, false - **arrowhead_included**: - for *bed*: true, false + Adding new tracks ----------------- diff --git a/pygenometracks/updateREADME.sh b/pygenometracks/updateREADME.sh new file mode 100644 index 00000000..1c7df3b8 --- /dev/null +++ b/pygenometracks/updateREADME.sh @@ -0,0 +1,15 @@ +# This bash script can be used to regenerate the README when parameters changed in tracksclasses. + +# Firts run the python script getAllDefaultsAndPossible.py +python pygenometracks/getAllDefaultsAndPossible.py + +# This generates 2 tables to include in the README +# First include the first one: docs/content/all_default_properties.txt +awk 'NR==1,//' README.md > newREADME.md +cat docs/content/all_default_properties.txt >> newREADME.md +awk '//{toprint = 1}toprint == 1{print}' README.md >> newREADME.md +# Then include the second one: docs/content/all_possible_properties.txt +awk 'NR==1,//' newREADME.md > README.md +cat docs/content/all_possible_properties.txt >> README.md +awk '//{toprint = 1}toprint == 1{print}' newREADME.md >> README.md +rm newREADME.md