search

cafferychen777 / MicrobiomeStat

Track, Analyze, Visualize: Unravel Your Microbiome's Temporal Pattern with MicrobiomeStat
https://www.microbiomestat.wiki/
31 stars 5 forks source link

Wiki Example Code Seems Outdated #55

Open DarioS opened 5 months ago

DarioS commented 5 months ago

In Feature-level Analysis, I see generate_taxa_volcano_single example but function is not present in version 1.2 on CRAN.

> library(MicrobiomeStat)
> generate_taxa_volcano_single
Error: object 'generate_taxa_volcano_single' not found

Also, is there plan to add MA plot to package? It would be a nice addiiton.

cafferychen777 commented 5 months ago

Dear Dario,

Thank you for reaching out regarding the generate_taxa_volcano_single function and the MA plot feature in the MicrobiomeStat package.

Please note that the MicrobiomeStat package is currently under active development, and many of the latest features have not yet been released to CRAN. To access the most up-to-date functionality, including the generate_taxa_volcano_single function, we recommend using the GitHub version of the package.

For detailed instructions on setting up the GitHub version of MicrobiomeStat, please refer to our installation guide: "https://www.microbiomestat.wiki/setting-up-microbiomestat-installation-and-data-preparation/kick-start-your-journey-the-microbiomestat-installation-guide"

Regarding the MA plot, we appreciate your suggestion and will consider adding this feature in a future release of the package.

If you have any further questions or concerns, please don't hesitate to reach out.

Best regards, Chen

DarioS commented 5 months ago

It is confusing because main branch is version 1.1.3. So, I thought CRAN is newer than GitHub because 1.2 is larger than 1.1.3.

cafferychen777 commented 5 months ago

Hi Dario,

I apologize for the confusion caused by the inconsistent versioning between the CRAN and GitHub releases of MicrobiomeStat.

You're correct that the main branch on GitHub is labeled as version 1.1.3, while the CRAN version is 1.2. However, the GitHub version actually contains more recent features and updates than the CRAN release, despite having an older version number.

This discrepancy is an oversight on my part. I should have updated the version number on GitHub to reflect the latest changes. I will rectify this as soon as possible to ensure clarity and consistency across the different release channels.

To summarize:

Thank you for bringing this issue to my attention. I appreciate your understanding and patience as I work to resolve the versioning inconsistency.

Best regards, Caffery