search

pdil / usmap

🗺 Create US maps including Alaska and Hawaii in R
https://usmap.dev/
GNU General Public License v3.0
74 stars 16 forks source link

Revisit function naming #25

Closed pdil closed 8 months ago

pdil commented 4 years ago

There are now a lot more functions within usmap than when the project was started. There should be some thought given to the naming of these functions going forward (before we reach a stable 1.0 release).

If the functions are to be changed, they will be renamed by v0.7.0 and the old function names will remain but be deprecated until v1.0.0 (where they will be removed).

Current Name Proposed Name
fips
fips_info
map_with_data
plot_usmap
usmap_crs
usmap_transform
usmap
trashbirdecology commented 4 years ago

I recommend changing usmap_transform to something different that does not include "usmap". This is confusing as it implies I am transforming your map, and not my data frame to conform to your maps.

pdil commented 2 years ago

Changed the target release for this change from v0.6.0 to v0.7.0 since usmapdata changes are going into v0.6.0. This allows for more separation of large changes between multiple releases.

pdil commented 8 months ago

Since it's been so long since I first came up with this idea I've decided to put it on hold since the functions have been named this way for many years at this point and there will be some friction to re-learning any new names, even with a deprecation schedule.

I may revisit this in the future, especially after 1.0 (if usmap ever even reaches that version number 🤪).