Skip to content

Commit 9fd265b

Browse files
authored
Update README.md
1 parent d6f2e27 commit 9fd265b

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Then, the two additional methods `set_tarc`, `plot_tree` and `plot_highlight` i
238238
#### Methods
239239
- **.add_tarc(tarc=*str*)**:
240240
Add a new Tarc or Garc class object into tarc_dict.
241-
- tarc : Tarc class object (default:None)
241+
- tarc : _Tarc class object_ (default:None)
242242
Tarc class object to be added.
243243

244244
**return** *None*
@@ -249,7 +249,7 @@ Then, the two additional methods `set_tarc`, `plot_tree` and `plot_highlight` i
249249
 - **tarc_id**: *str*
250250
ID of the Tarc class object. The ID should be in Tcircle
251251
- **object.tarc_dict**: *dict*
252-
- **rlim** : **tuple** (top=int, bottom=int)
252+
- **rlim** : *tuple* (top=int, bottom=int)
253253
The top and bottom r limits in data coordinates. The default vlaues is (0, 700).
254254
If the first value is less than second value, tree will be outward direction.
255255
If the first value is larger than second value, tree will be inward direction.
@@ -258,31 +258,31 @@ Then, the two additional methods `set_tarc`, `plot_tree` and `plot_highlight` i
258258
to visualize the clade. A sub-dict is composed of the following key-value pairs:
259259
- **size**: *int* or *float*
260260
Size of dot. The default value is 5.
261-
- **color**: *float* or *str* replresenting color code.
261+
- **color**: *float* or *str* replresenting color code.
262262
Face color of dot. The default value is '#303030'.
263-
- **edgecolor**: *float* or *str* replresenting color code.
263+
- **edgecolor**: *float* or *str* replresenting color code.
264264
Edge line color of dot. The default value is '#303030'.
265-
- **linewidth**: *int* or *float*
265+
- **linewidth**: *int* or *float*.
266266
Edge line width of dot. The default value is 0.5.
267267

268268
**return** *None*
269269

270270

271271
- **.plot_tree(tarc_id=*str*, highlight_dict=*dict*)**:
272272
Add highlight for specif clade under the given internal clade.
273-
- **highlight_dict**: *dict*
273+
- **highlight_dict**: *dict*
274274
Dictionay composed of pairs of internal clade name and a sub-dict.
275275
Instead of clade name, tuples of teminal clade names can also be used.
276276
A sub-dict is composed of the following key-value pairs:
277-
- **color**: *str*
277+
- **color**: *str*
278278
Color of highlight for clades. The default value is "#000000".
279-
- **alpha**: *flaot*
279+
- **alpha**: *flaot*
280280
Alpha of highlight for clades. The default vlalue is 0.25.
281-
- **label**: *str*
281+
- **label**: *str*
282282
Label. The default vlalue is None.
283-
- **fontsize**: int or float
283+
- **fontsize**: int or float
284284
Fontsize of label. The default vlalue is 10.
285-
- **y**: *int* or *float*
285+
- **y**: *int* or *float*
286286
Y location of the text. The default vlalue is the bottom edge of the highliht.
287287

288288
**return** *None*

0 commit comments

Comments
 (0)