search

MUCollective / multiverse

R package for creating explorable multiverse analysis
https://mucollective.github.io/multiverse/
GNU General Public License v3.0
62 stars 5 forks source link

Document .options parameter for branch() #64

Closed mjskay closed 4 years ago

mjskay commented 4 years ago

It does not seem to be documented?

abhsarma commented 4 years ago

do you mean the different options arguments that can be specified using branch() ?

mjskay commented 4 years ago

Yeah, if I look at help("branch") it does not list the .options argument.

abhsarma commented 4 years ago

rn its specified as ... but I guess I can expand on it and have a section called Options However, I dont think it should be a .options argument as that might give the perception that its a single argument whereas the way it is specified actually seems like you can declare multiple What do you think?

mjskay commented 4 years ago

I'm referring to the .options argument that we created in https://github.com/MUCollective/multiverse/issues/36#issuecomment-539303694 and which is a separate alternative to .... Since it's not the same as ... it should be documented as a separate parameter, no?

abhsarma commented 4 years ago

oh sorry, I forgot about that one!

mjskay commented 4 years ago

No worries! 🙂

abhsarma commented 4 years ago

also one thing I realised is that R usually does partial matching with its functions, but since branch is not a function, it wont support partial matching on args like .options. something we should be concerned about?

mjskay commented 4 years ago

Nah, partial matching is a horrible misfeature :)