Re: [Bioc-devel] Doubt with deprecating a function

2016-10-20 Thread Obenchain, Valerie
Hi,

You need to add \alias{multiCorrMethExprs} at the top of
MEAL-defunct.Rd. Documentation of exported functions is confirmed by an
alias entry in a man page.

The .Defunct() message says that multiCorrMethExprs() was found not
useful and removed. If it was replaced by another function (maybe not in
this case) I'd mention that in the man page. You could also mention in
what version it became defunct. Other than that it looks good.

Valerie

On 10/20/2016 12:13 AM, Carlos Ruiz wrote:
> Hi everyone,
>
> I am the developer of MEAL package. In the previous release, I 
> deprecated a function (multiCorrMethExprs). In this release, I marked 
> this function as defuncted. I followed the instructions of 
> Bioconductor's web page: I included the defunct function in the body of 
> my function, I removed its manual page and I added a new manual page 
> with the deprecated function name. I forgot to do these steps until the 
> very last day and now my package has a warning in the release branch:
>
>> * checking for missing documentation entries ... WARNING Undocumented 
>> code objects: 'multiCorrMethExprs' All user-level objects in a package 
>> should have documentation entries. See chapter 'Writing R 
>> documentation files' in the 'Writing R
> Do you know how I can solve this issue? I know that is not very 
> important and I will be solved in the next release when I won't export 
> this function. However, I would like to learn how to properly defunct a 
> function.
> Bests,
>



This email message may contain legally privileged and/or confidential 
information.  If you are not the intended recipient(s), or the employee or 
agent responsible for the delivery of this message to the intended 
recipient(s), you are hereby notified that any disclosure, copying, 
distribution, or use of this email message is prohibited.  If you have received 
this message in error, please notify the sender immediately by e-mail and 
delete this email message from your computer. Thank you.
___
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel


[Bioc-devel] Doubt with deprecating a function

2016-10-20 Thread Carlos Ruiz
Hi everyone,

I am the developer of MEAL package. In the previous release, I 
deprecated a function (multiCorrMethExprs). In this release, I marked 
this function as defuncted. I followed the instructions of 
Bioconductor's web page: I included the defunct function in the body of 
my function, I removed its manual page and I added a new manual page 
with the deprecated function name. I forgot to do these steps until the 
very last day and now my package has a warning in the release branch:

> * checking for missing documentation entries ... WARNING Undocumented 
> code objects: 'multiCorrMethExprs' All user-level objects in a package 
> should have documentation entries. See chapter 'Writing R 
> documentation files' in the 'Writing R

Do you know how I can solve this issue? I know that is not very 
important and I will be solved in the next release when I won't export 
this function. However, I would like to learn how to properly defunct a 
function.
Bests,

-- 
Carlos Ruiz
PhD Student
ISGlobal
Barcelona Institute for Global Health - Campus MAR
Barcelona Biomedical Research Park (PRBB) (office 001)
Doctor Aiguader, 88
08003 Barcelona, Spain
Tel. +34 93 214 7309
carlos.r...@isglobal.org
www.isglobal.org

We are pleased to tell you that after three years of a strategic alliance 
between ISGlobal and CREAL, both institutions have merged. The resulting 
institution, which retains the ISGlobal name, will build upon the existing 
areas of excellence to become a world-class player in research, education and 
innovation in Global Health. More info at: http://ow.ly/krQd301Nj3w

  

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: 
l...@isglobal.org. ISGlobal Privacy Policy at 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: 
l...@isglobal.org. ISGlobal Privacy Policy at 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 l...@isglobal.org . Política de privacidad en 
www.isglobal.org.

[[alternative HTML version deleted]]

___
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel