search

epiforecasts / RtD3

Rt visualisation in D3
https://epiforecasts.io/RtD3/
Other
6 stars 2 forks source link

Question: function names #27

Closed hamishgibbs closed 3 years ago

hamishgibbs commented 3 years ago

We are calling a lot of things widgets which isn't my favourite word to say or type.

The name of the function doesn't have anything to do with the underlying JavaScript so we could change names to something more R-thonic?

like rt_dashboard instead of summaryWidget?

Just a thought - happy to hear your thoughts as you already have the package implemented somewhere @seabbs.

seabbs commented 3 years ago

yes, good point. Probably don't need to include rt in the name as already part of the package name though (which is something I like about the current naming scheme actually). In general supportive of a naming change but not clear to what.

It could be as simple as (obviously using Camel case): 

RtD3::dashboard()

RtD3::plot_timeseries()

RtD3::plot_timepoint()

I will just need a bit of warning if this happens so I don't update RtD3 where the website gets updated until all the uses are also updated.

seabbs commented 3 years ago

action on this or close?

hamishgibbs commented 3 years ago

Close for now. Package is working fine and we can make these changes if they are required in the future.