Question

Question about sharing a function in the R package

0

Entering edit mode

Jing Wang ▴ 10

@jing-wang-5523

Last seen 7.1 years ago

Hi,

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

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

Thanks,

R • 630 views

ADD COMMENT • link updated 7.1 years ago by Steve Lianoglou ★ 13k • written 7.1 years ago by Jing Wang ▴ 10

score 1 · Answer 1 · 2017-03-30

1

Entering edit mode

Steve Lianoglou ★ 13k

@steve-lianoglou-2771

Last seen 13 months ago

United States

Sometimes the person that needs the documentation the most is the one who wrote the function, and trying to figure out what it's doing 6 months from now.

What's the harm in documenting it? Just don't export it is all ...

ADD COMMENT • link 7.1 years ago Steve Lianoglou ★ 13k

1

Entering edit mode

Further on Steve's answer; if you plan to develop R packages, you must read the "Writing R Extensions" guide at https://cran.r-project.org/doc/manuals/r-release/R-exts.html. Scrolling down to Section 1.5.1 ("Specifying imports and exports") would have told you everything you needed to know. In addition, this question is better suited to the BioC-devel mailing list. It seems that you have asked the same thing on the mailing list already - in which case, don't double-post the question here.

ADD REPLY • link 7.1 years ago Aaron Lun ★ 28k