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

[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 using ecoccs.com> wrote:

> 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
>
>
> --
> --
> No fear, Only Love! / ¡No temas, solamente amor!
> -Irucka Ajani Embry, 15 March 2020
>
> Family Partners:
> http://www.sustainlex.org/
> https://www.schoolingsolutions.com/
>
>
> ---------------------------------------------------------------------------------------------------------------
>
> The business collaboration between EConsulting (tm)
> [https://www.econsultingllc.org/] and EcoC^2S, is Getting Back to
> Nature.
>
> Getting Back to Nature LocalHarvest --
> https://www.localharvest.org/getting-back-to-nature-M73453
> Getting Back to Nature -- https://www.gettingback2nature.farm/
>
> -- Irucka and his twin brother, Obiora, are featured in the Middle
> Tennessee Local Table Magazine Annual issue. The article discusses their
> family farm history and the current work that they are doing under
> Getting
> Back to Nature. The full magazine can be found here [the article begins
> on
> page 18 of the PDF document]:
>
> https://media.gettingback2nature.farm/pdf/LocalTable_ANNUAL_2020_lo_res.pdf
>
> -- Obiora and Irucka were interviewed separately in early 2020 for the
> Natural Resources Defense Council's (NRDC) "Regenerative Agriculture:
> Farm
> Policy for the 21st Century: Policy Recommendations to Advance
> Regenerative
> Agriculture" report written By Arohi Sharma, Lara Bryant, and Ellen Lee.
> The PDF report is available below:
>
>
> https://www.nrdc.org/sites/default/files/regenerative-agriculture-farm-policy-21st-century-report.pdf
>
> EcoC2S -- https://www.ecoccs.com/
> Principal, Irucka Embry, EIT
>
> Services:
> Growing Food
> Healthy Living Mentor
> Data Analysis with R
> R Training
> Chemistry and Mathematics Tutoring
> Free/Libre and Open Source Software (FLOSS)
> Consultation______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>

	[[alternative HTML version deleted]]