mlr3spatiotempcv

Spatiotemporal resampling methods for mlr3

https://github.com/mlr-org/mlr3spatiotempcv

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    2 of 12 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary

Keywords

cross-validation mlr3 r r-package resampling resampling-methods spatial temporal

Keywords from Contributors

reproducibility battery animal data-profilers datacleaner parallel pipeline-testing yolov5s meshing interpretability
Last synced: 4 months ago · JSON representation

Repository

Spatiotemporal resampling methods for mlr3

Basic Info
Statistics
  • Stars: 52
  • Watchers: 14
  • Forks: 9
  • Open Issues: 4
  • Releases: 20
Topics
cross-validation mlr3 r r-package resampling resampling-methods spatial temporal
Created about 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Codemeta

README.md

mlr3spatiotempcv

Package website: release | dev

Spatiotemporal resampling methods for mlr3.

CRAN Status Coverage status Lifecycle: stable CodeFactor

This package extends the mlr3 package framework with spatiotemporal resampling and visualization methods.

If you prefer the tidymodels ecosystem, have a look at the {spatialsample} package for spatial sampling methods.

Installation

CRAN version

r install.packages("mlr3spatiotempcv")

Development version

```r remotes::install_github("mlr-org/mlr3spatiotempcv")

R Universe Repo

install.packages('mlr3spatiotempcv', mlrorg = 'https://mlr-org.r-universe.dev') ```

Get Started

See the "Get Started" vignette for a quick introduction.

For more detailed information including an usage example see the "Spatiotemporal Analysis" chapter in the mlr3book.

Article "Spatiotemporal Visualization" shows how 3D subplots grids can be created.

Citation

To cite the package in publications, use the output of citation("mlr3spatiotempcv").

Resources

Other spatiotemporal resampling packages

This list does not claim to be comprehensive.

(Disclaimer: Because CRAN does not like DOI URLs in their automated checks, direct linking to scientific articles is not possible...)

| Name | Language | Resources | | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | blockCV | R | CRAN | | CAST | R | Paper, CRAN | | ENMeval | R | CRAN | | spatialsample | R | CRAN | | sperrorest | R | CRAN | | Pyspatialml | Python | GitHub | | spacv | Python | GitHub | | Museo Toolbox | Python | Paper, GitHub | | spatial-kfold | Python | GitHub |

FAQ

Which resampling method should I use?
There is no single-best resampling method. It depends on your dataset characteristics and what your model should is about to predict on. The resampling scheme should reflect the final purpose of the model - this concept is called "target-oriented" resampling. For example, if the model was trained on multiple forest plots and its purpose is to predict something on unknown forest stands, the resampling structure should reflect this.
Are there more resampling methods than the one {mlr3spatiotempcv} offers?
{mlr3spatiotempcv} aims to offer all resampling methods that exist in R. Though this does not mean that it covers all resampling methods. If there are some that you are missing, feel free to open an issue.
How can I use the "blocking" concept of the old {mlr}?
This concept is now supported via the "column roles" concept available in {mlr3} [Task](https://mlr3.mlr-org.com/reference/Task.html) objects. See [this documentation](https://mlr3.mlr-org.com/reference/Resampling.html#grouping-blocking) for more information.
For the methods that offer buffering, how can an appropriate value be chosen?
There is no easy answer to this question. Buffering train and test sets reduces the similarity between both. The degree of this reduction depends on the dataset itself and there is no general approach how to choosen an appropriate buffer size. Some studies used the distance at which the autocorrelation levels off. This buffer distance often removes quite a lot of observations and needs to be calculated first.

Owner

  • Name: mlr-org
  • Login: mlr-org
  • Kind: organization
  • Location: Munich, Germany

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "mlr3spatiotempcv",
  "description": "Extends the mlr3 ML framework with spatio-temporal resampling methods to account for the presence of spatiotemporal autocorrelation (STAC) in predictor variables. STAC may cause highly biased performance estimates in cross-validation if ignored.",
  "name": "mlr3spatiotempcv: Spatiotemporal Resampling Methods for 'mlr3'",
  "relatedLink": [
    "https://mlr3spatiotempcv.mlr-org.com/",
    "https://mlr3book.mlr-org.com"
  ],
  "codeRepository": "https://github.com/mlr-org/mlr3spatiotempcv",
  "issueTracker": "https://github.com/mlr-org/mlr3spatiotempcv/issues",
  "license": "https://spdx.org/licenses/LGPL-3.0",
  "version": "2.0.3.9000",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.2.3 (2023-03-15)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Patrick",
      "familyName": "Schratz",
      "email": "patrick.schratz@gmail.com",
      "@id": "https://orcid.org/0000-0003-0748-6624"
    },
    {
      "@type": "Person",
      "givenName": "Marc",
      "familyName": "Becker",
      "email": "marcbecker@posteo.de",
      "@id": "https://orcid.org/0000-0002-8115-0400"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Jannes",
      "familyName": "Muenchow",
      "email": "jannes.muenchow@uni-jena.de",
      "@id": "https://orcid.org/0000-0001-7834-4717"
    },
    {
      "@type": "Person",
      "givenName": "Michel",
      "familyName": "Lang",
      "email": "michellang@gmail.com",
      "@id": "https://orcid.org/0000-0001-9754-0393"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Patrick",
      "familyName": "Schratz",
      "email": "patrick.schratz@gmail.com",
      "@id": "https://orcid.org/0000-0003-0748-6624"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "bbotk",
      "name": "bbotk",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=bbotk"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "blockCV",
      "name": "blockCV",
      "version": ">= 3.1.2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=blockCV"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "caret",
      "name": "caret",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=caret"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "ggsci",
      "name": "ggsci",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggsci"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "ggtext",
      "name": "ggtext",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggtext"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "here",
      "name": "here",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=here"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "lgr",
      "name": "lgr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=lgr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "mlr3filters",
      "name": "mlr3filters",
      "version": ">= 0.7.0.9000",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mlr3filters"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "mlr3pipelines",
      "name": "mlr3pipelines",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mlr3pipelines"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "mlr3tuning",
      "name": "mlr3tuning",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mlr3tuning"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "patchwork",
      "name": "patchwork",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=patchwork"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "plotly",
      "name": "plotly",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=plotly"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rpart",
      "name": "rpart",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rpart"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "sperrorest",
      "name": "sperrorest",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sperrorest"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "terra",
      "name": "terra",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=terra"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "vdiffr",
      "name": "vdiffr",
      "version": ">= 1.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=vdiffr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "withr",
      "name": "withr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=withr"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "mlr3",
      "name": "mlr3",
      "version": ">= 0.12.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mlr3"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.5.0"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "checkmate",
      "name": "checkmate",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=checkmate"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "data.table",
      "name": "data.table",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=data.table"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "ggplot2",
      "name": "ggplot2",
      "version": ">= 3.4.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "mlr3misc",
      "name": "mlr3misc",
      "version": ">= 0.11.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mlr3misc"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "paradox",
      "name": "paradox",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=paradox"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "R6",
      "name": "R6",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=R6"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "SystemRequirements": null
  },
  "fileSize": "12423.354KB"
}

GitHub Events

Total
  • Create event: 6
  • Issues event: 2
  • Release event: 2
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 8
  • Push event: 202
  • Pull request event: 7
Last Year
  • Create event: 6
  • Issues event: 2
  • Release event: 2
  • Watch event: 2
  • Delete event: 2
  • Issue comment event: 8
  • Push event: 202
  • Pull request event: 7

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,002
  • Total Committers: 12
  • Avg Commits per committer: 83.5
  • Development Distribution Score (DDS): 0.184
Past Year
  • Commits: 8
  • Committers: 2
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.125
Top Committers
Name Email Commits
pat-s p****z@g****m 818
Alexander Brenning a****g@u****e 68
be-marc m****r@p****e 52
jannes-m m****a@g****e 21
Michel Lang m****g@g****m 21
pre-commit-ci[bot] 6****] 7
jannes.muenchow j****w@g****m 7
github-actions[bot] 4****] 4
mb706 m****6 1
jawond j****k@g****m 1
Lorenz Walthert l****t@i****m 1
Alexander Brenning y****w@a****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 45
  • Total pull requests: 61
  • Average time to close issues: 3 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 12
  • Total pull request authors: 4
  • Average comments per issue: 2.49
  • Average comments per pull request: 1.56
  • Merged pull requests: 53
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 7 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.4
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • pat-s (30)
  • pfistfl (4)
  • mcoghill (2)
  • jannes-m (1)
  • konstantinschellenberg (1)
  • fitzLab-AL (1)
  • cstepper (1)
  • TheOysterPrince (1)
  • mb706 (1)
  • be-marc (1)
  • mohammadreza-sheykhmousa (1)
  • jue-d (1)
  • mafla (1)
Pull Request Authors
  • pat-s (48)
  • be-marc (13)
  • mllg (4)
  • jannes-m (1)
  • mb706 (1)
Top Labels
Issue Labels
Status: Accepted (3) Type: Enhancement (3) Priority: Medium (2) Type: Bug (2) Type: Question (1) Priority: High (1) Status: In Progress (1) Priority: Low (1)
Pull Request Labels
CRAN release :station: (5) Type: Bug (1)

Dependencies

.github/workflows/tic.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v2 composite
  • pat-s/always-upload-cache v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-tinytex v2 composite
.github/workflows/update-tic.yml actions
  • actions/checkout v3 composite
  • peter-evans/create-pull-request v4 composite
  • r-lib/actions/setup-r v2 composite
DESCRIPTION cran
  • R >= 3.5.0 depends
  • mlr3 >= 0.12.0 depends
  • R6 * imports
  • checkmate * imports
  • data.table * imports
  • ggplot2 * imports
  • mlr3misc >= 0.9.2 imports
  • paradox * imports
  • utils * imports
  • bbotk * suggests
  • blockCV >= 2.1.4 suggests
  • caret * suggests
  • ggsci * suggests
  • ggtext * suggests
  • here * suggests
  • knitr * suggests
  • lgr * suggests
  • mlr3filters * suggests
  • mlr3pipelines * suggests
  • mlr3tuning * suggests
  • patchwork * suggests
  • plotly * suggests
  • raster * suggests
  • rgdal * suggests
  • rmarkdown * suggests
  • rpart * suggests
  • sf * suggests
  • skmeans * suggests
  • sperrorest * suggests
  • terra * suggests
  • testthat >= 3.0.0 suggests
  • vdiffr >= 1.0.0 suggests
  • withr * suggests