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

Dependencies [minor issue] #110

Closed
adRn-s opened this issue Nov 3, 2021 · 4 comments · Fixed by #115
Closed

Dependencies [minor issue] #110

adRn-s opened this issue Nov 3, 2021 · 4 comments · Fixed by #115
Labels

Comments

@adRn-s
Copy link

adRn-s commented Nov 3, 2021

I have run all the docs without any trouble, except for the need to manually install Dictionaries in order to use its classes and methods. Thankfully, the clear narration and explicit mention of this dependency helped a lot. So it is nothing that the users would be unaware. But for the sake of simplicity, I am opening the issue so that it can be addressed.

Leaving the installation issues aside, there's no mention in the docs about loading the libraries: Microbiome, Dictionaries, or SparseArrays. I understand the first one is obvious, but the other two shouldn't be autoloaded with the first one? I had to add the import lines of code here and there when the functions through an error while following the docs.

@kescobo kescobo added the docs label Nov 3, 2021
@kescobo
Copy link
Member

kescobo commented Nov 3, 2021

Can you point me to the part of the docs you're referring to? I searched the docs for "sparse" and "spzeros" and only found this spot, which does explicitly show using SparseArrays, and for "dict" which got me here - that spot does need using Dictionaries. There's also a missing link there.

Are you looking in the BiobakeryUtils tutorials as well?

@aguang
Copy link

aguang commented Nov 3, 2021

The stable version of the docs does not have the using SparseArrays line.

@kescobo
Copy link
Member

kescobo commented Nov 4, 2021

Ahh - good point. I'll add your suggestion from #111 and tag another version.

@kescobo
Copy link
Member

kescobo commented Nov 4, 2021

This will be at least partly addressed by #115 - I added MicrobiomeSample constructors for julia base Dicts as well as NamedTuples. The type still uses Dictionaries.jl under the hood, but a user shouldn't have to worry about adding that as a separate dependency in order to work with the type, I think.

@kescobo kescobo linked a pull request Nov 5, 2021 that will close this issue
kescobo added a commit that referenced this issue Nov 5, 2021
* add note about julia version; fixes issue #111

* Other improvements to README.md

* add dictionary and named tuple constructors; fixes #110

* Improve docstrings for feature types; fixes #114

* docstring refinements

* add vingette for readin in data; fixes #112

* attempt to resolve Documenter issues

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

Successfully merging a pull request may close this issue.

3 participants