Documentation - Githubissues

dwinter / pafr

Read, manipulate and visualize 'Pairwise mApping Format' data in R

Other

65 stars 8 forks source link

Documentation #1

Closed dwinter closed 3 years ago

dwinter commented 5 years ago

All exported functions should have documentation, including all arguments
README should show a quick/motivating example
Vignette should show how to read data, manipulating it and most common plots

dwinter commented 4 years ago

All exported functions have some documentation, but still need examples, cross references and proofreading of all exported functions:

[x] chrom_sizes
[x] dotplot
[x] filter_secondary_alignments
[x] highlight_query
[x] highlight_target
[x] plot_coverage
[x] plot_synteny
[x] read_bed
[x] read_paf
[x] theme_coverage_plot