peilun-he / PDSim

Web application for the polynomial diffuison model
Apache License 2.0
0 stars 1 forks source link

Functionality documentation #7

Closed bkrayfield closed 8 months ago

bkrayfield commented 10 months ago

This paper can be improved by adding more documentation on how to use the package outside of the actual method being implemented.

Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

peilun-he commented 9 months ago

All major functions have been exported. Users can use them outside of the application. A section named "How to Use PDSim (R Script)" gives examples of how to use these functions.

bkrayfield commented 8 months ago

@peilun-he Wow, great work adding useful documentation. I am satisfied. Just as a further comment, not mandatory, but you might consider adding another page for some of the more detailed usage, rather than have everything on one page.