Skip to content

[R-pkg-devel] Package internal function / Undocumented code objects warning

4 messages · EcoC2S - Irucka Embry, Neal Fultz, Andrew Simmons +1 more

Original
EcoC2S - Irucka Embry
# 
Greetings, I am attaching the complete R file for your review. The 
vlookup_internal function and all of the functions in the package are 
derived from the expss package version 0.10.7. The vlookup function was 
modified in later versions so I gathered what I needed from that 
previous version and included in the attached R file.

The vlookup_internal function is meant to be an internal function that 
is used by the vlookup and other functions. I have documented the 
vlookup_internal function to escape the warning message, but it doesn't 
seem to work.

I am enclosing the warning message below:

* checking for missing documentation entries ... WARNING
Undocumented code objects:
   ?vlookup_internal?
All user-level objects in a package should have documentation entries.
See chapter ?Writing R documentation files? in the ?Writing R
Extensions? manual.

Thank you.

Irucka Embry
Neal Fultz
# 
If it's an internal-only function check if it's exported in your NAMESPACE
file.

On Fri, Feb 24, 2023 at 1:12 PM EcoC2S - Irucka Embry <iembry at ecoccs.com>
wrote:

  
  


  


      

    

    

      
      

        


  

        

      Andrew Simmons
    

    

      
      #
    

  


  

      
I'm not very familiar with Roxygen, so I might be making incorrect
assumptions here.

Why are you exporting a function if it's meant to be internal?

And the @noRd would indicate that a documentation file is not created. I
would remove @noRd or @export

        
On Fri, Feb 24, 2023, 16:11 EcoC2S - Irucka Embry <iembry at ecoccs.com> wrote:

        

            

      
      
      
    

        

      
      
    

        

  
  


  


      

    

    

      
      

        


  

        

      Andy Teucher
    

    

      
      #
    

  


  

      
You have included the @export tag in the roxygen block for vlookup_internal(), which will place it in the NAMESPACE with an export directive, but also included @noRd which prevents the creation of the .Rd file for the function. So these two are in conflict. Remove the @export tag from vlookup_internal and when you re-run devtools::document() it should no longer be in the NAMESPACE.

Cheers,
Andy Teucher