microbiome / miaSim

microbiome data simulation package
https://microbiome.github.io/miaSim/
Artistic License 2.0
18 stars 10 forks source link

estimateAFromSimulations examples #60

Closed antagomir closed 1 year ago

antagomir commented 1 year ago

The function estimateAFromSimulations is essential.

Therefore it should be clearly shown in some appropriate function manpage (roxygen documentation) example how to use this, and/or in the vignette.

gaoyu19920914 commented 1 year ago

This was done here previously. Now that the data container is changed, and I will work on it soon.

antagomir commented 1 year ago

Ok great.

As far as I can see, no changes to the function estimateAFromSimulations are needed because it is not representing community data.

However if this function has changed in some way, open the PR so that we can take it now into account in any subsequent development.

gaoyu19920914 commented 1 year ago

OK!

I confirm that the function estimateAFromSimulations takes lists of simulations (generated by generateSimulations) as input, and treat the lists of simulations only with getCommunity.

Therefore, it's true that there's nothing to change to this function as long as the generateSimulations and getCommunity works well with the TreeSE data.

antagomir commented 1 year ago

These were removed in the latest PR, I just noticed.

I have now added this back in PR #63 that is pending automated checks.

Some updates were necessary, it will be essential to check afterwards that the outputs are as expected.