search

epiverse-trace / blueprints

Software development blueprints for epiverse-trace
https://epiverse-trace.github.io/blueprints
Other
4 stars 4 forks source link

Outdated Base R support section #116

Closed joshwlambert closed 2 weeks ago

joshwlambert commented 1 month ago

I believe the table stating the versions of base R that are supported is now outdated. We could consider dynamically rendering this from the GitHub action workflow, to try and prevent it being outdated in the future.

joshwlambert commented 2 weeks ago

The code use to produce the tidyverse R version policy: https://github.com/tidyverse/tidyverse.org/blob/main/content/blog/2019/r-version-support/index.Rmd#L28-L63.

joshwlambert commented 2 weeks ago

Due to PR deploy previews only working on quarto documents without code we cannot use the same approach as the tidyverse blog post.

joshwlambert commented 2 weeks ago

We could consider dynamically rendering this from the GitHub action workflow, to try and prevent it being outdated in the future.

It was also mentioned in #80 that automating this step might not be worth the effort.

Bisaloo commented 2 weeks ago

We don't know how future R versions will be numbered anyways so it's tricky to create the table for many years ahead. I believe the current situation, where it shows what the policy meant a couple of years ago and a couple of years ahead, is useful to understand the idea.

What do you think?

joshwlambert commented 2 weeks ago

Yes, I agree. This is likely more complication than is necessary. The only difference between the Epiverse table and tidyverse table is the number of past R releases.

Last point on the automation, we could use the {rversions} package, but it seems overly complex to make the query ourselves, e.g. https://github.com/r-hub/rversions/blob/master/R/rversions.R#L86-L118.

Therefore, I think we can rename the Current R version to R version (like the tidyverse table), which then removes the issue of the table becoming outdated and then close this issue without further action required.

@Bisaloo please let me know if you agree.

Bisaloo commented 2 weeks ago

Or "Current R version" -> "Latest R version" if you prefer?

Current makes sense to me as I read it as "Current R version as of year X".

joshwlambert commented 2 weeks ago

Or "Current R version" -> "Latest R version" if you prefer?

I was initially thinking that current and latest would make it seem that this is the current/latest release from CRAN, which was the reasoning for opening this issue due to table including 2023 and R v4.3.

Current makes sense to me as I read it as "Current R version as of year X".

In this case then we can leave the table as is, because we can show what the past minimum supported version is, the current and then the upcoming versions.

Let's close this issue without any modifications.