Coder Social home page Coder Social logo

Comments (7)

florianhartig avatar florianhartig commented on July 20, 2024

Can you have a look if there is an option to suppress this?

from bayesiantools.

stefan-paul avatar stefan-paul commented on July 20, 2024

According to the documentation only functions with the
export label should be exported.
But I'll have another look!

from bayesiantools.

stefan-paul avatar stefan-paul commented on July 20, 2024

Done with b9d8bc4 .
Just commented out all the roxygen commands for the not-exported functions.
However, I still think that this is somewhat strange. According to the roxygen docs we
did it the right way, so the functions should not have appared in the namespace....

from bayesiantools.

florianhartig avatar florianhartig commented on July 20, 2024

This seems to be a known problem

http://stackoverflow.com/questions/41411044/need-to-document-arguments-in-functions-which-are-not-exported-in-r-package

In this one Ben also suggests to use normal comments as we have it now. This here

http://stackoverflow.com/questions/15892761/do-not-show-function-help-document-in-building-r-package-by-roxygen2

states that

http://stackoverflow.com/questions/15892761/do-not-show-function-help-document-in-building-r-package-by-roxygen2

helps - can you check this out, just to know?

from bayesiantools.

stefan-paul avatar stefan-paul commented on July 20, 2024

Ok. I'll have a look tomorrow.

from bayesiantools.

stefan-paul avatar stefan-paul commented on July 20, 2024

Just checked. The '@Keywords internal' version creates a help page which can be accessed
with ?foo. However, the funtion itself does not show in the namespace.
Regular # instead of the roxygen #' don't create a help page and the
function is not exported in the namespace.
I would tend to use the latter version to truly keep the functions internal.
@florianhartig what's your opinion?

from bayesiantools.

florianhartig avatar florianhartig commented on July 20, 2024

yes, I agree! Done.

from bayesiantools.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.