Dev #140
Dev #140
Conversation
Standardized temperature file naming in documentation and refactored tag_create_dataframe to use temperature_internal_file instead of temperature_external_file for air temperature data. This improves clarity and consistency in parameter usage.
…ion works well Refactored the parameter name 'tag_graph' to 'graph' in edge_add_wind and related internal functions for consistency. Updated documentation and all references to use the new parameter name.
There was a problem hiding this comment.
Pull Request Overview
This PR contains primarily documentation and formatting improvements across multiple R package files. The changes focus on reformatting code comments, correcting parameter names, and updating documentation strings.
- Reformatted text wrapping in function descriptions and documentation
- Updated parameter names for consistency (e.g.,
tag_graphtograph, temperature file naming) - Added unit specification for pressure data documentation
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| man/twilight_create.Rd | Reformatted function description text wrapping |
| man/tag_create.Rd | Updated temperature file parameter names and added pressure unit specification |
| man/geopressure_map.Rd | Reformatted text wrapping in documentation |
| man/edge_add_wind.Rd | Changed parameter name from tag_graph to graph and reformatted description |
| R/twilight_create.R | Reformatted function description text wrapping |
| R/tag_create_dataframe.R | Updated temperature parameter handling from external to internal |
| R/tag_create.R | Updated temperature file parameter names and added pressure unit specification |
| R/graph_add_wind.R | Updated parameter reference in documentation |
| R/geopressure_map.R | Reformatted text wrapping in comments |
| R/edge_add_wind.R | Renamed parameter from tag_graph to graph throughout function |
| \item \code{temperature_external_file = "temperature.csv"} (optional) | ||
| \item \code{temperature_external_file = "airtemperature.csv"} (optional) | ||
| \item \code{temperature_external_file = "temperature_external.csv"} (optional) | ||
| \item \code{temperature_external_file = "temperature_external.csv"} (optional) |
There was a problem hiding this comment.
The documentation shows the same file name 'temperature_external.csv' for both lines 93 and 94, which appears to be a duplicate. One should likely be 'temperature_internal.csv' to match the parameter naming in the code.
| \item \code{temperature_external_file = "temperature_external.csv"} (optional) | |
| \item \code{temperature_internal_file = "temperature_internal.csv"} (optional) |
| if (!is.null(temperature_external_file)) { | ||
| assertthat::assert_that(assertthat::has_name(temperature_external_file, c("date", "value"))) | ||
| assertthat::assert_that(inherits(temperature_external_file$date, "POSIXct")) | ||
| if (!is.null(temperature_internal_file)) { |
There was a problem hiding this comment.
The parameter name was changed from 'temperature_external_file' to 'temperature_internal_file', but the function signature and documentation may not have been updated accordingly. This could cause the function to fail when called with the expected parameter name.
No description provided.