New package: WykoOPDReader v0.1.2

[JuliaRegistrator]

• Registering package: WykoOPDReader
• Repository: https://github.com/jaakkor2/WykoOPDReader.jl
• Created by: @jaakkor2
• Version: v0.1.2
• Commit: a55c4c1d3c6400b43c9cdbf01b077e77279d6647
• Reviewed by: @jaakkor2
• Reference: Register jaakkor2/SurfaceProfileReaders.jl#1 (comment)
• Description: Reader for Wyko datasets (.opd)

[github-actions]

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines are all met! ✅

Your new package registration met all of the guidelines for auto-merging and is scheduled to be merged when the mandatory waiting period (3 days) has elapsed.

3. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

[goerz]

Thank you for submitting your package! However, could you extend the documentation in the README a little bit more? It would probably be good for "Wyko OPD profilometer datasets" to be a link to some page that explains the format and gives some context. Please also explain what the type of data is that results from readopd, and what one might be able to do with that object.

[jaakkor2]

[noblock] Thank you @goerz for taking the time to review new package entries. Now I found Matlab script many by Veeco https://mtl.mit.edu/pipermail/labnetwork/attachments/20110711/1f04a0e6/attachment.ksh that seems be the best available description of the OPD format. I added a link to that to README.md. Also, docstring for readopd had already a plotting example. Hopefully these answers your concerns.

[goerz]

Closing in favor of #118158

In the future, please do not change the version number when addressing issues with the registration.

Hopefully these answers your concerns

My question was about the type of data. It seems like it might be Dict. You'll want to document that, and which keys the dict has, and what information the dict values contain.