search

borstell / tidysigns

Other
1 stars 0 forks source link

Suggestion: Include actual sample `.eaf`, `.ilex`, and `.cmdi` files in package #1

Closed math-mcshane closed 4 weeks ago

math-mcshane commented 1 month ago

Hello! I don't know any sign language and don't know about these kinds of files! Still, this looks like a neat project. I found this via Mastodon.

I think it would be helpful for users of the package to have some example files to work/play with (maybe non-trivially small?) by reading them in themselves.

From the R Packages book, here's how/why you might do that.

Maybe the small example files could be related to a baby sign language chart like this one? (Like I said, I'm not sure I understand what's happening here and whether that's even a helpful suggestion).

borstell commented 4 weeks ago

Thanks for the suggestion!

I have opted not to include any data in the package to keep things as lightweight as possible. The package is only really relevant to those already working with (some of) these files, but I have considered adding examples to the README of reading existing corpus files available online, since the functions can also read contents from URL paths directly.