add a readme file with R_CMD check action

Author: ehrlinger

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,58 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+name: R-CMD-check.yaml
+
+permissions: read-all
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+    
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+    
+      - if: runner.os == 'macOS'
+        run: |
+            brew install checkbashisms
+            brew install --cask xquartz
+          
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+          rtools-version: '42'
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

README.md

@@ -0,0 +1,39 @@
+randomForestSRC - Fast Unified Random Forests for Survival, Regression, and Classification (RF-SRC)
+========================================================
+<!-- badges: start -->
+
+[![cranlogs](http://cranlogs.r-pkg.org/badges/randomForestSRC)](http://cranlogs.r-pkg.org/badges/randomForestSRC)
+[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/randomForestSRC)](https://cran.r-project.org/package=randomForestSRC)
+
+[![active](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/badges/latest/active.svg)
+
+[![R-CMD-check](https://github.com/ehrlinger/randomForestSRC/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ehrlinger/randomForestSRC/actions/workflows/R-CMD-check.yaml)
+[![Codecov test coverage](https://codecov.io/gh/ehrlinger/ggRandomForests/graph/badge.svg)](https://app.codecov.io/gh/ehrlinger/ggRandomForests)
+
+<!-- badges: end -->
+
+R-software for random forests regression, classification, survival analysis, competing risks, multivariate, unsupervised, quantile regression, and class imbalanced q-classification. Extreme random forests and randomized splitting. Suite of imputation methods for missing data. Fast random forests using subsampling. Confidence regions and standard errors for variable importance. New improved holdout importance. Case-specific importance. Minimal depth variable importance. Visualize trees on your Safari or Google Chrome browser. Anonymous random forests for data privacy. New Mahalanobis splitting rule for correlated real-valued outcomes in multivariate regression settings.
+
+## Documentation
+
+https://www.randomforestsrc.org/ 
+
+https://ishwaran.org/
+
+## Installation
+
+The production release is available on CRAN at 
+```{r}
+install.packages("randomForestSRC") 
+```
+
+Install the development version into your R environment using the `devtools` package:
+```{r}
+install.packages("devtools") # If you don't have it.
+
+# Requires randomForestSRC dependency.
+devtools::install_github("kogalur/randomForestSRC")
+```
+## References
+
+Lu M., Ishwaran H. Model-independent variable selection via the rule-based variable priority [arXiv:2409.09003 ](https://arxiv.org/abs/2409.09003) **[stat.ML]**