Add explicit 'parameters' arg to coord_map() in response to PR #1699 #1729
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
|
Can you fix the examples and add a bullet point to NEWS please? |
|
Instead of modifying the original examples, I made coord_map() backwards-compatible by reinstating the ... argument. NEWS.md file is updated to reflect the coord_map() fix. |
| @@ -21,7 +21,8 @@ | |||
| #' @export | |||
| #' @param projection projection to use, see | |||
| #' \code{\link[mapproj]{mapproject}} for list | |||
| #' @param ... other arguments passed on to | |||
| #' @param ... other arguments passed on to mapproject. Ignored if the \code{parameters} argument is present. | |||
| #' @param parameters optional numeric vector of parameters for use with the projection argument. This argument is optional only in the sense that certain projections do not require additional parameters. Passed to | |||
There was a problem hiding this comment.
Can you please break this line up? Otherwise looks good.
|
Added line breaks to coord_map() docs. Should be ready to merge in. |
|
Thanks! |
ghost
mentioned this pull request
|
This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/ |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I replaced the ... argument in coord_map() with parameters = NULL and added a new example in its help file for a projection that needs a 'parameters' argument. This fixes the bug mentioned in PR #1699.
In the previous version of coord_map(), the ... argument only served to pass the 'parameters' argument to mapproj::mapproject(), so it can be safely removed. I also added documentation about the new 'parameters' argument in coord_map().
P.S. I've now realized the proper workflow would have been to modify the original pull request at #1699 , but it's too late now.