Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve visibility of documentation and tests #11

Open
gareth-d-ga opened this issue Feb 24, 2022 · 2 comments
Open

Improve visibility of documentation and tests #11

gareth-d-ga opened this issue Feb 24, 2022 · 2 comments

Comments

@gareth-d-ga
Copy link
Collaborator

At the moment:

  • rptha has documentation in R format, extracted from Roxygen-style comments in the code.
  • other R scripts often use Roxygen-style comments in the code, although as they are not in packages, they are not processed into browse-able formats.
  • SWALS has source-code documentation which can be converted to html via Ford.
  • All the SWALS validation tests can be run and produce figures.

It would be nice to make all this more easily accessible via the web.
@gareth-d-ga
Copy link
Collaborator Author

README.md blurbs are being added to the SWALS validation tests, and it is possible to merge them into a pdf

@gareth-d-ga
Copy link
Collaborator Author

We've now got the SWALS validation test README.md files to link to figures (stored on another branch to avoid repo bloat). This makes it much easier to see the SWALS tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gareth-d-ga