selkamand / ggoncoplot

Easily Create Interactive Oncoplots
https://selkamand.github.io/ggoncoplot/
Other
2 stars 0 forks source link

Add a 'options' argument to ggoncoplot that controls all the visual properties so the roxygen documentation is cleaner #90

Closed selkamand closed 2 months ago

selkamand commented 2 months ago

Currently ggoncoplot takes a large number of arguments to allow users fine control over the look of the the oncoplot. This approach is fine but it does mean the help for ggoncoplot is enormous and cluttered which can make its use feel more intimidating.

A better solution is to add an options argument and a ggoncoplot_options function that supplies all the options in list format for ggoncoplot to use.

That way if a user wants to see all the visual paramaters they can tweak, they can simply look through ?ggoncoplot_options or click the link to ggoncoplot_options documentation from the ggoncoplot documentation itself

ggoncoplot(
    gbm_df 
    col_genes = 'Hugo_Symbol', 
    col_samples = 'Tumor_Sample_Barcode', 
    col_mutation_type = 'Variant_Classification', 
    options = ggoncoplot_options(
        fontsize_xlab = 26,
        fontsize_ylab = 26,
        fontsize_genes = 16
    )
)