[R-pkg-devel] Changes in function call with respect to the current published version

Wed Dec 18 18:37:07 CET 2024

Dear Jose,

On 2024-12-18 10:26 a.m., John Fox wrote:
> Caution: External email.
> 
> 
> Dear Jose,
> 
> Assuming that you can fix the bugs in the original function, one
> approach would be to make myfun() generic, say myfun <- function(y, ...)
> UseMethod("myfun"), with the (fixed) original myfun() as the default
> method and a new function method, which would probably set up a call to

That should read "a new formula method" (not "a new function method").

Sorry for the confusion,
  John

> the default method. Then existing code wouldn't break and users would
> have the option of using a formula.
> 
> I hope this helps,
>   John
> -- 
> John Fox, Professor Emeritus
> McMaster University
> Hamilton, Ontario, Canada
> web: https://www.john-fox.ca/
> -- 
> 
> On 2024-12-17 4:00 p.m., Jose Barrera-Gómez wrote:
>> [You don't often get email from jose.barrera using isglobal.org. Learn why 
>> this is important at https://aka.ms/LearnAboutSenderIdentification ]
>>
>> Caution: External email.
>>
>>
>> Dear List,
>>
>> I have a package that works in the context of regression models. The main
>> function has arguments (y, x, z, data, ...), where y is the response
>> variable, x is the explanatory variable and z can be other covariates.
>>
>> Due to some bugs, I am interested in changing the call from (y, x, z, 
>> data,
>> ...) to (formula, data, ...).
>>
>> For instance, current usage is
>>
>> myfun(y = birthweight, x = cotinine, z = age, data = mydata, ...)
>>
>> and new usage would be
>>
>> myfun(formula = birthweight ~ cotinine + age, data = mydata, ...)
>>
>> This change would have no impact on the usage for the rest of the 
>> package.
>>
>> My concern is that users updating the package won't be able to reproduce
>> old analyses. I.e. they would need to update the calls to myfun (but
>> nothing else related to the usage of other functions or methods).
>>
>> I think the new usage would result in some advantages and bugs fixing and
>> only the disadvantage I mentioned just above.
>>
>> I would appreciate advice on:
>>
>> 1) There could be other disadvantages for users of previous versions 
>> that I
>> don't see?
>>
>> 2) What would be the best location(s) in the documentation to explain in
>> detail this change?
>>
>> Thanks in advance,
>>
>> Jose Barrera
>> Statistician, Associate Lecturer
>>
>> *IS**Global*
>> Barcelona Institute for Global Health - Campus MAR
>> Barcelona Biomedical Research Park (PRBB) (Room Hypatia)
>>
>> Doctor Aiguader, 88
>> 08003 Barcelona, Spain
>> Tel. +34 93 2147383
>> jose.barrera using isglobal.org
>> <https://www.linkedin.com/in/josebarrera>
>> Personal website: sites.google.com/view/josebarrera
>> www.isglobal.org
>>
>> This message is intended exclusively for its addressee and may contain
>> information that is CONFIDENTIAL and protected by professional privilege.
>> If you are not the intended recipient you are hereby notified that any
>> dissemination, copy or disclosure of this communication is strictly
>> prohibited by law. If this message has been received in error, please
>> immediately notify us via e-mail and delete it.
>>
>> DATA PROTECTION. We inform you that your personal data, including your
>> e-mail address and data included in your email correspondence, are 
>> included
>> in the ISGlobal Foundation filing system. Your personal data will be used
>> for the purpose of contacting you and sending information on the 
>> activities
>> of the above foundations. You can exercise your rights to  access to
>> personal data, rectification, erasure, restriction of processing, data
>> portability and object by contacting the following address: 
>> *lopd using isglobal.org
>> <lopd using isglobal.org>*. ISGlobal Privacy Policy at *www.isglobal.org
>> <http://www.isglobal.org/>*.
>>
>>
>> -----------------------------------------------------------------------------------------------------------------------------
>>
>> CONFIDENCIALIDAD. Este mensaje y sus anexos se dirigen exclusivamente 
>> a su
>> destinatario y puede contener información confidencial, por lo que la
>> utilización, divulgación y/o copia sin autorización está prohibida por la
>> legislación vigente. Si ha recibido este mensaje por error, le rogamos lo
>> comunique inmediatamente por esta misma vía y proceda a su destrucción.
>>
>> PROTECCIÓN DE DATOS. Sus datos de carácter personal utilizados en este
>> envío, incluida su dirección de e-mail, forman parte de ficheros de
>> titularidad de la Fundación ISGlobal  para cualquier finalidades de
>> contacto, relación institucional y/o envío de información sobre sus
>> actividades. Los datos que usted nos pueda facilitar contestando este
>> correo quedarán incorporados en los correspondientes ficheros, 
>> autorizando
>> el uso de su dirección de e-mail para las finalidades citadas. Puede
>> ejercer los derechos de acceso, rectificación, supresión, limitación del
>> tratamiento, portabilidad y oposición dirigiéndose a *lopd using isglobal.org
>> <lopd using isglobal.org>* . Política de privacidad en *www.isglobal.org
>> <http://www.isglobal.org/>*.
>>
>> -- 
>>
>>
>> This message is intended exclusively for its addressee and may contain
>> information that is CONFIDENTIAL and protected by professional privilege.
>> If
>> you are not the intended recipient you are hereby notified that any
>> dissemination, copy or disclosure of this communication is strictly
>> prohibited
>> by law. If this message has been received in error, please
>> immediately notify
>> us via e-mail and delete it.
>>
>>
>>
>> DATA PROTECTION. We
>> inform you that your personal data, including your
>> e-mail address and data
>> included in your email correspondence, are included in
>> the ISGlobal
>> Foundation files. Your personal data will be used for the purpose
>> of
>> contacting you and sending information on the activities of the above
>> foundations. You can exercise your rights of access, rectification,
>> cancellation and opposition by contacting the following address:
>> lopd using isglobal.org <mailto:lopd using isglobal.org>. ISGlobal
>> Privacy Policy at
>> www.isglobal.org <http://www.isglobal.org/>.
>>
>>
>>
>> -----------------------------------------------------------------------------------------------------------------------------
>>
>> CONFIDENCIALIDAD. Este mensaje y sus anexos se dirigen exclusivamente a
>> su
>> destinatario y puede contener información confidencial, por lo que la
>> utilización,
>> divulgación y/o copia sin autorización está prohibida por la
>> legislación
>> vigente. Si ha recibido este mensaje por error, le rogamos lo
>> comunique
>> inmediatamente por esta misma vía y proceda a su destrucción.
>>
>>
>>
>>
>>
>>
>>
>>
>>
>> PROTECCIÓN DE DATOS. Sus datos de carácter personal utilizados en este
>> envío, incluida su dirección de e-mail, forman parte de ficheros de
>> titularidad
>> de la Fundación ISGlobal  para cualquier
>> finalidades de
>> contacto, relación institucional y/o envío de información sobre
>> sus
>> actividades. Los datos que usted nos pueda facilitar contestando este
>> correo quedarán incorporados en los correspondientes ficheros, 
>> autorizando
>> el
>> uso de su dirección de e-mail para las finalidades citadas. Puede
>> ejercer los
>> derechos de acceso, rectificación, cancelación y oposición
>> dirigiéndose a lopd using isglobal.org <mailto:lopd using isglobal.org>* *. 
>> Política de
>> privacidad
>> en www.isglobal.org <http://www.isglobal.org/>.
>>
>>          [[alternative HTML version deleted]]
>>
>> ______________________________________________
>> R-package-devel using r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
> 
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel