ailich / GLCMTextures

This R package calculates the most common gray-level co-occurrence matrix (GLCM) texture metrics used for spatial analysis on raster data.
https://ailich.github.io/GLCMTextures/
GNU General Public License v3.0
12 stars 4 forks source link

Small improvements #21

Closed kadyb closed 1 year ago

kadyb commented 1 year ago

Hi Alex, congratulations on releasing the packages on CRAN! I think you can consider these things to improve the user experience:

  1. Add BugReports field to DESCRIPTION: BugReports: https://github.com/ailich/GLCMTextures/
  2. Create pkgdown website
  3. Add CRAN badge to README: [![CRAN](https://www.r-pkg.org/badges/version/GLCMTextures)](https://cran.r-project.org/package=GLCMTextures). And maybe badge with license?
ailich commented 1 year ago

Thanks @kadyb. I've added those suggestions. The equations however aren't rendering properly on the packagedown website. Any chance you know how to address that. I remember adding the option --webtex to the Readme so that it'd display properly on github however, it seems that may be causing an issue on the packagedown site. Do you have any suggestions. I tried changing the option to --mathml but it made no difference.

kadyb commented 1 year ago

I changed --webtex to --mathml and single $ to double $$ and this works: https://kadyb.github.io/GLCMTextures/

BTW: I tried to fork this repository on GitHub, but there is the error: Description cannot be more than 350 characters. Maybe you should shorten the "About" section?

ailich commented 1 year ago

Thanks, I shortened the about section so not the repo can be forked. I'm still having issues rendering the packagedown website even though I made both the --mathml and $$ changes.

ailich commented 1 year ago

I updated knitr and rmarkdown and now I do get some warnings (e.g. see below), but it renders properly.

[WARNING] Could not convert TeX math \text{GLCM Mean} (\mu) = \sum{i,j=0}^{N-1} i(P{i,j}), rendering as TeX igma^2) = \sum{i,j=0}^{N-1} P{i,j}(i-\mu)^2, rendering as TeX