[Bioc-devel] Doubt with deprecating a function
Obenchain, Valerie
Valerie.Obenchain at roswellpark.org
Thu Oct 20 16:05:08 CEST 2016
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.
More information about the Bioc-devel
mailing list