Create vignette - #3
Merged
Merged
Conversation
Add a new vignette demonstrating clamp, wrap, interpolation, remapping, L2 normalization, and adjacent-difference workflows. Update DESCRIPTION to include the knitr/rmarkdown vignette dependencies and enable vignette building.
Introduce a new R Markdown vignette covering the numops bounds helpers: clamp(), clamp01(), in_range(), and wrap(). It explains interval semantics, vectorization/recycling rules, missing and infinite value behavior, and practical validation/correction workflows with examples and a visualization of periodic wrapping.
Add generated documentation and package metadata directories to the ignore lists so local build artifacts like doc/, Meta/, and docs/ are not tracked or included in package builds.
This commit updates the package build metadata to match the repository layout and refreshes the release description. The .Rbuildignore file now ignores the docs directory, and the DESCRIPTION file is set back to version 1.0.0 while expanding the package summary to better describe the supported numerical operations and edge-case behavior.
Cleaned the package DESCRIPTION by removing the legacy Type field and reformatting the Authors@R entry into a compact multi-line style while preserving the same metadata and package identity.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request introduces documentation improvements and metadata updates for the
numopsR package. The main changes include adding two comprehensive vignettes that demonstrate package usage, updating the package description for clarity and accuracy, and refining the build ignore file to exclude documentation directories.Documentation additions:
numerical-operations-in-r.Rmdthat provides an overview and practical examples of all major functions innumops, covering clamping, wrapping, interpolation, remapping, division, normalization, and adjacent differences. This serves as a general introduction and reference for users.clamp-test-wrap-numeric-values.Rmdfocused on clamping, range testing, and wrapping numeric values, with detailed explanations, examples, and guidance on edge cases and workflow integration.Metadata and build configuration:
DESCRIPTIONto clarify the package description, add vignette-related dependencies (knitr,rmarkdown), specify the vignette builder, and correct the package version and author formatting..Rbuildignoreto excludedoc,Meta, anddocsdirectories from package builds, preventing unnecessary files from being included in the build artifact.