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.

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

Enhancements to Dataset Documentation and Wiki Generation for ZekDex #10

Merged
merged 20 commits into from
May 13, 2024

Conversation

zekrom-vale
Copy link
Owner

Pull Request for ZekDex

Issue Being Addressed
This PR addresses several issues:

  • Fixes Data issue: Column data mismatch #9 by ensuring CSV will quote everything
  • Works on Migrate to Wiki's #5 and Documentation add examples #7 by creating a wiki update action, moving data to the wiki, migrating dataset docs to yaml, expanding on dataset descriptions, fixing the issue of missing language yaml, generating mans, making README.md generated by gen_readme.R, generating the wiki files with gen_md.R, generating the sidebar by directory, changing it to generate md, and updating it to a different format

Summary of Changes
The changes include a series of commits that primarily focus on improving the dataset documentation and the generation of markdown files for the wiki. This includes the creation of a wiki update action, moving data to the wiki, migrating dataset docs to yaml, expanding on dataset descriptions, fixing the issue of missing language yaml, generating mans, making README.md generated by gen_readme.R, generating the wiki files with gen_md.R, generating the sidebar by directory, changing it to generate md, updating it to a different format, ensuring CSV will quote everything, adding a ggplot fill based on type, fixing rendering of defending_*, regenerating data, adding missed exports, ignoring some files, and incrementing the version.

Update Data or @importFrom Directives
The changes involved regenerating data. If new data was added, it can be updated in the future by following the same process used in this PR.

Testing Instructions

devtools::check()
0 errors| 7 warnings| 3 notesError: R CMD check found WARNINGs
Execution halted

Please note that the check resulted in warnings and notes. These will be addressed later.

Additional Notes
This PR includes a series of changes that significantly improve the documentation and organization of the ZekDex package. It addresses several issues and makes the package easier to use and understand. However, the devtools::check() resulted in some warnings and notes that need to be addressed.

Now files in wiki will cause update the wiki
Processing will work fine.  May automate this later.
It was randomly inserting new lines breaking the roxyogen
Added sources and references.  Also expanded on the description.  Need to integrate into md gen
Still need to move to a short description
GitHub wiki expects md
See if that's better #5
This can fix the issue: `quote = "all"`.  Need to regenerate the data though.
@zekrom-vale zekrom-vale added documentation Improvements or additions to documentation enhancement New feature or request R data Something about data csv labels May 13, 2024
@zekrom-vale zekrom-vale self-assigned this May 13, 2024
@zekrom-vale zekrom-vale merged commit 5d24d06 into stable May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
csv data Something about data documentation Improvements or additions to documentation enhancement New feature or request R
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant