search

NIEHS / beethoven

BEETHOVEN is: Building an Extensible, rEproducible, Test-driven, Harmonized, Open-source, Versioned, ENsemble model for air quality
https://niehs.github.io/beethoven/
Other
5 stars 0 forks source link

Extended documentation for developers #350

Open sigmafelix opened 3 months ago

sigmafelix commented 3 months ago

I am working on a developer's guide and the description on the targets/branches' internal structure in ./inst/targets/README.md. The first aim is to write up the descriptions up to base learners, which should be done simultaneously with updating base learners per our resolved strategies.

Documentation aside, most of the functions are highly dependent on specific files and object structures in the pipeline, so most of the codebase is wrapped in # nocov. At the current development phase, I think we don't need to think about increasing the "true" code coverage, but it will be good to do that in the long run.

sigmafelix commented 3 months ago

As many might have noticed, the developer's guide is merged into README.md in the project root.

sigmafelix commented 3 months ago

The current PR (#355) has descriptions up to base learner fitting. Roxygen2 documentations were elaborated following the changes from 0.4.0 work.