Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write official DAISIE data standard documentation #38

Closed
joshwlambert opened this issue Dec 22, 2021 · 6 comments
Closed

Write official DAISIE data standard documentation #38

joshwlambert opened this issue Dec 22, 2021 · 6 comments
Assignees

Comments

@joshwlambert
Copy link
Owner

No description provided.

@richelbilderbeek
Copy link
Collaborator

I think an overview in the main DAISIEmainland::DAISIEmainland doc would be the best place for that. I volunteer to do all the island structures :-)

@joshwlambert joshwlambert self-assigned this Dec 29, 2021
@joshwlambert
Copy link
Owner Author

I have tried writing up the data standards in DAISIEmainland::DAISIEmainland but I feel it is better suited to a vignette.

@joshwlambert
Copy link
Owner Author

@richelbilderbeek do you think all data structures should have the suffix *_data?

@richelbilderbeek
Copy link
Collaborator

richelbilderbeek commented Dec 29, 2021

I have tried writing up the data standards in DAISIEmainland::DAISIEmainland but I feel it is better suited to a vignette.

Cool, looking forward to see it!

@richelbilderbeek do you think all data structures should have the suffix *_data?

I feel that, usually, data is redundant or inexpressive. As an exampke, in English we usually speak about colonisation history or community ontology, instead of colonisation data. Especially a word like datalist says exactly nothing; better would be to express of what it is the data of.

As always, feel free to ignore :-)

@joshwlambert
Copy link
Owner Author

@richelbilderbeek thanks for the tips, I decided to keep the data suffix as for some it gave clarity and I use it for all for consistency. Let me know if you're happy with the naming and I will start changing the names currently used in the package. See #5cc1708 on standards branch.

@richelbilderbeek
Copy link
Collaborator

Nice!

I've taken a look at the vignette, I feel it is a good start!

I see the use of the multi_prefix when using _data as a suffix, as the singular of _data equals the plural _data, and _datas is not exactly English. However, for _clade, English has the plural _clades. Well, I guess you prefer multi_ for consistency, so having said that, I think these are good conventions :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants