EcoJulia / Microbiome.jl

For analysis of microbiome and microbial community data
Other
47 stars 10 forks source link

Dependencies [minor issue] #110

Closed adRn-s closed 2 years ago

adRn-s commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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

kescobo commented 2 years ago

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

kescobo commented 2 years ago

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.