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

[JOSS] Figure summarizing functionality #12

Closed
edeno opened this issue May 23, 2023 · 1 comment
Closed

[JOSS] Figure summarizing functionality #12

edeno opened this issue May 23, 2023 · 1 comment

Comments

@edeno
Copy link

edeno commented May 23, 2023

This is not necessary, but in your documentation after this line:

You can use this package to either extract pre-defined motifs from the time series (such as time-in-zone, climbing, basic social interactions) or to embed your data into a sequence-aware latent space to extract meaningful motifs in an unsupervised way! Both of these can be used within the package, for example, to automatically compare user-defined experimental groups.

It would be nice for the user to see a basic figure illustrating what your package can do. It would help users more quickly understand what your package can do. You more or less have them in your documentation but you have to dig for them for users to see it.

xref: openjournals/joss-reviews#5394

@lucasmiranda42
Copy link
Collaborator

Dear @edeno, thanks! I have added a simple figure describing what the package does after the mentioned line. I think it's a pretty cool suggestion! Let me know what you think or if you'd suggest any modifications.

Best!
Lucas

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