GithubHelp home page GithubHelp logo

undocumented code objects about sdmbench HOT 4 CLOSED

goldingn avatar goldingn commented on August 30, 2024
undocumented code objects

from sdmbench.

Comments (4)

goldingn avatar goldingn commented on August 30, 2024

there were few other issues flagged by these checks (so it might be worth running those), but that was the only one I'm particularly concerned about for the JOSS review.

from sdmbench.

boyanangelov avatar boyanangelov commented on August 30, 2024

Those functions are used to enable dismo to use mlr predictions. They are not going to be used directly by the user. Do you know if there is a better way to include them in the package?

I just ran the checks as well, did not see anything else which should be fixed there.

from sdmbench.

goldingn avatar goldingn commented on August 30, 2024

Ah, I see now that you are currently exporting every function in your package: https://github.com/boyanangelov/sdmbench/blob/master/NAMESPACE#L1

You can instead explicitly export the functions that you expect the user to interact with. You could add them individually to NAMESPACE with e.g. export(function), but it's normally easier to have roxygen auto-generate your NAMESPACE based on @export tags in the documentation for the functions you want to export. Your importFrom NAMESPACE lines can be generated from roxygen too, using @importFrom tags

from sdmbench.

boyanangelov avatar boyanangelov commented on August 30, 2024

Thanks for the advice @goldingn! I just pushed the changes, now everything is generated by roxygen.

from sdmbench.

Related Issues (14)

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.