Re: [Bioc-devel] Question about R functions

2017-03-31 Thread Sean Davis 
And note the existence of the "Internal" keyword for documentation:

http://www.hep.by/gnu/r-patched/r-exts/R-exts_50.html


On Fri, Mar 31, 2017 at 5:35 AM, Wolfgang Huber 
wrote:

>
> Thanks Juan; the .point used to be a way to do this, but since the
> introduction of namespaces to R, it is neither necessary nor sufficient for
> private functions. See e.g. .Hub in the AnnotationHub package, or the .Call
> function in base.
>
> See https://cran.r-project.org/doc/manuals/r-release/R-exts.html
> #Package-namespaces
> http://r-pkgs.had.co.nz/namespace.html
>
> Wolfgang
>
> 30.3.17 22:46, Juan David Henao Sanchez scripsit:
>
>> Hi Wang
>>
>> You can create internal functions calling them as ".function", the point
>> is
>> necessary to declare an internal function. Additionally, you can put all
>> your internal functions in the same R file and is not necessary create the
>> documentation for this functions.
>>
>> Best regards.
>>
>> Juan D. Henao
>>
>> 2017-03-30 15:02 GMT-05:00 Jing Wang :
>>
>> Hi,
>>>
>>>
>>>
>>> I have three functions (FA,FB,FC) in the package and all these functions
>>> need to call another function (FD). But I do not want other users to use
>>> the function FD and thus I do not want to create the document for FD in
>>> the
>>> R package.
>>>
>>>
>>>
>>> Could you please give me some suggestion how to do that?
>>>
>>>
>>>
>>> Thanks,
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>> [[alternative HTML version deleted]]
>>>
>>> ___
>>> Bioc-devel@r-project.org mailing list
>>> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>>>
>>>
>>
>>
>>
> ___
> Bioc-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>



-- 
Sean Davis, MD, PhD
Center for Cancer Research
National Cancer Institute
National Institutes of Health
Bethesda, MD 20892
https://seandavi.github.io/
https://twitter.com/seandavis12

[[alternative HTML version deleted]]

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

Re: [Bioc-devel] Question about R functions

2017-03-31 Thread Wolfgang Huber 


Thanks Juan; the .point used to be a way to do this, but since the 
introduction of namespaces to R, it is neither necessary nor sufficient 
for private functions. See e.g. .Hub in the AnnotationHub package, or 
the .Call function in base.


See 
https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Package-namespaces

http://r-pkgs.had.co.nz/namespace.html

Wolfgang

30.3.17 22:46, Juan David Henao Sanchez scripsit:

Hi Wang

You can create internal functions calling them as ".function", the point is
necessary to declare an internal function. Additionally, you can put all
your internal functions in the same R file and is not necessary create the
documentation for this functions.

Best regards.

Juan D. Henao

2017-03-30 15:02 GMT-05:00 Jing Wang :


Hi,



I have three functions (FA,FB,FC) in the package and all these functions
need to call another function (FD). But I do not want other users to use
the function FD and thus I do not want to create the document for FD in the
R package.



Could you please give me some suggestion how to do that?



Thanks,








[[alternative HTML version deleted]]

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







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

Re: [Bioc-devel] Question about R functions

2017-03-30 Thread Nathan Sheffield 

HI Jing,

You should export FA FB and FC, but don't export FD. If using roxygen2 
for documentation you use "#' @export" on the ones to export, and just 
don't document FD and it won't be exported by default.


Hope that helps,

-Nathan


On 03/30/2017 04:02 PM, Jing Wang wrote:

Hi,

  


I have three functions (FA,FB,FC) in the package and all these functions need 
to call another function (FD). But I do not want other users to use the 
function FD and thus I do not want to create the document for FD in the R 
package.

  


Could you please give me some suggestion how to do that?

  


Thanks,

  

  

  



[[alternative HTML version deleted]]

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


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

Re: [Bioc-devel] Question about R functions

2017-03-30 Thread Juan David Henao Sanchez 
Hi Wang

You can create internal functions calling them as ".function", the point is
necessary to declare an internal function. Additionally, you can put all
your internal functions in the same R file and is not necessary create the
documentation for this functions.

Best regards.

Juan D. Henao

2017-03-30 15:02 GMT-05:00 Jing Wang :

> Hi,
>
>
>
> I have three functions (FA,FB,FC) in the package and all these functions
> need to call another function (FD). But I do not want other users to use
> the function FD and thus I do not want to create the document for FD in the
> R package.
>
>
>
> Could you please give me some suggestion how to do that?
>
>
>
> Thanks,
>
>
>
>
>
>
>
>
> [[alternative HTML version deleted]]
>
> ___
> Bioc-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>



-- 
Juan David Henao
Maestría en Bioinformática
Universidad Nacional de Colombia

[[alternative HTML version deleted]]

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

[Bioc-devel] Question about R functions

2017-03-30 Thread Jing Wang 
Hi,

 

I have three functions (FA,FB,FC) in the package and all these functions need 
to call another function (FD). But I do not want other users to use the 
function FD and thus I do not want to create the document for FD in the R 
package.

 

Could you please give me some suggestion how to do that?

 

Thanks,

 

 

 


[[alternative HTML version deleted]]

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