How to handle refactored plot code

[mariusbarth]

Hi @crsh,

on a feature branch, I kept a rewrite of the apa_***plot() family of functions that would enable using pipes to customize these plots, and would also provide a formula interface. To enable pipes, the return value of these functions is very different to what these functions currently (invisibly) return, so even though the current output is probably rarely or never used, would break backwards compatibility.

Before we submit to CRAN, I wanted to ask if a) I should finish work on the new implementation or b) we make clear in the documentation that the return value is subject to change (currently, the return value is not documented).

[crsh]

Hmm, I think this depends on how much more work you would want to put into the changes. I would prefer to strive for as good a backward compatibility as we can once we are on CRAN. I mean, we have gone out of our way to ensure backward compatibility up until this point anyway, but I agree that this particular breaking change is unlikely to affect any user.

[crsh]

@mariusbarth What's the status on this issue?

[mariusbarth]

Last time we discussed this matter, we concluded that, at the moment, it is the best solution to add a note regarding the return value, which is what I did on the development branch.

A (nested) list of plot options. Note that the structure of the return value is about to change in a forthcoming release of papaja.

[crsh]

Ah, yes. Thanks for refreshing my memory.