search

ropensci / mapscanner

R package to print maps, draw on them, and scan them back in
https://docs.ropensci.org/mapscanner/
Other
90 stars 7 forks source link

Clarify use of "scan" in documentation #16

Closed mpadge closed 5 years ago

mpadge commented 5 years ago

According to review of @potterzot:

This may be a GB/US difference. Throughout the package the use of the word "scan" to mean "reading an image file into R" is confusing. In the U.S., most users will take this to mean actually using a scanner. For example, the documentation for ms_rectify_maps() reads "Scan in two pdf or png maps, rectify them ...". But the function isn't scanning anything. This happens in other places such as the README. I would suggest working on package and individual function descriptions to clarify that the package deals with images that have been scanned in but doesn't do any scanning. I.e. the package allows users to converted scanned images into sf objects, but doesn't operate the scanner. In the US "read" would probably best replace "scan".