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

Wiki Example Code Seems Outdated #55

Open
DarioS opened this issue May 30, 2024 · 3 comments
Open

Wiki Example Code Seems Outdated #55

DarioS opened this issue May 30, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@DarioS
Copy link

DarioS commented May 30, 2024

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.

@DarioS DarioS added the documentation Improvements or additions to documentation label May 30, 2024
@cafferychen777
Copy link
Owner

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
Copy link
Author

DarioS commented May 30, 2024

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
Copy link
Owner

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:

  • The GitHub version, although labeled 1.1.3, is the most up-to-date and includes features like generate_taxa_volcano_single that are not yet available in the CRAN release.
  • I will update the GitHub version number to properly reflect its current state and avoid further confusion.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants