-
Notifications
You must be signed in to change notification settings - Fork 0
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
added
documentation
Improvements or additions to documentation
enhancement
New feature or request
R
data
Something about data
csv
labels
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request for ZekDex
Issue Being Addressed
This PR addresses several issues:
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
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.