Add family functions & remove manual seealso#780
Merged
Conversation
Order: ``` @describeIn @rdname/name @param @returns @family @Rdname @export @importFrom @Keywords @details/section @references @examples ``` Also: - remove whitespace - use `@returns` not `@return` - remove importFrom This change largely has no effect on the rd files, except for some minor whitespace changes and: - attribute_table.Rd which now has the description correctly shown as description (not part of the ... param) - integrate_to_ppi: don't duplicate references
Document digits param with inheritParams base::print
It was currently used inconsistently. I've now applied `@noRd` for all. I've also removed `@keywords internal` as that is reserved for helper functions that do need an `Rd` file, but not be listed in the function overview. For the public beam_profile I had to update the inheritParams form gaussian_beam_profile (noRd) to a beam_height and beam_width (both public) Two functions are remove from the NAMESPACE: read_stout and methods, as Ping @adokter @bart1
They're all listed under the same rdname
Makes more sense to group them under param and scan then under polar accessor functions
Avoids having the clunky polar accessor functions
peterdesmet
approved these changes
Jul 2, 2026
peterdesmet
left a comment
peterdesmet
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @YohanSassi!
Additional changes
- Use consistent order for roxygen tags aac4030. This also fixes a description that was listed as a param in
attribute_table()and double references inintegrate_to_ppi() - Export print functions aac4030
- Don't create rd for internal functions 99062de
- Rename Ops to operators.Rd ca3895b
Changes to function reference
Reading radar data
print(<pvol>)addedselect(<pvol>),select(<scan>)repeatedget_elevation_angles()repeated
Inspecting radar scans
print(<scan>)addedselect(<pvol>),select(<scan>)moved here from "Manipulating radar scans"print(<param>)added
Manipulating radar scans
- No changes (other than listed above)
Plotting radar scans
- Deprecated functions not listed
print(<ppi>)added
Creating vertical profiles of biological targets
nexrad_to_odim()not repeated
Reading vertical profile data
read_vpts()moved here from "Manipulating vertical profile data"
Inspecting vertical profile data
- New section, to separate from reading functions
- Moved here from "Reading vertical profile data":
example_vp()plot(<vp>)summary(<vp>), etc. andprint(<vp>)added
- Moved here from "Manipulating vertical profile data":
example(<vpts>)plot(<vpts>)[(<vpts>)(now its own page)get_quantity()summary(<vpts>), etc.
Manipulating vertical profile data
- Moved here from "Accessing vertical profile metadata"
rcs<-()sd_vvp_threshold<-()
Integrating vertical profiles
- No changes
Accessing vertical profile metadata
- No changes (other than listed above)
Radar beam geometry
- No changes
Other functions
- No changes
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
2 participants
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.
fix #531