Data

Tools

Indexes

Applications

Experiments

Open Source Science

evaluatelm

This module was created to exemplify an evaluation procedure fora linear model. The model prints prediction error (ResidualStandard Error, or RSE), how well the model fits the data(R-squared and adjusted R2, or R2), and plots residual vs fittedvalues, Normal Q-Q Plot, ans performs Cross-Validation.

https://github.com/tati-micheletti/evaluatelm

Science Score: 67.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

This module was created to exemplify an evaluation procedure fora linear model. The model prints prediction error (ResidualStandard Error, or RSE), how well the model fits the data(R-squared and adjusted R2, or R2), and plots residual vs fittedvalues, Normal Q-Q Plot, ans performs Cross-Validation.

Basic Info
  • Host: GitHub
  • Owner: tati-micheletti
  • License: mit
  • Language: HTML
  • Default Branch: main
  • Size: 790 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created almost 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog License Citation

README.md

title: "evaluateLM Manual" subtitle: "v.1.0.0" date: "Last updated: 2024-04-12" output: bookdown::htmldocument2: toc: true tocfloat: true theme: sandstone numbersections: false dfprint: paged keepmd: yes editoroptions: chunkoutputtype: console bibliography: citations/references_evaluateLM.bib link-citations: true

alwaysallowhtml: true

evaluateLM Module

(ref:evaluateLM) evaluateLM

made-with-Markdown DOI <!-- if knitting to pdf remember to add the pandoc_args: ["--extract-media", "."] option to yml in order to get the badge images -->

Authors:

Tati Micheletti tati.micheletti@gmail.com [aut, cre] <!-- ideally separate authors with new lines, '\n' not working -->

Module Overview

Module summary

This module was created to exemplify an evaluation procedure for a linear model. The model prints prediction error (Residual Standard Error, or RSE), how well the model fits the data (R-squared and adjusted R2, or R2), and plots residual vs fitted values, Normal Q-Q Plot, performs Cross-Validation.

Module inputs and parameters

The no parameters are used and the only input is an object of the class lm|glm named abundTempLM.

Table \@ref(tab:moduleInputs-evaluateLM) shows the full list of module inputs.

(\#tab:moduleInputs-evaluateLM)(\#tab:moduleInputs-evaluateLM)List of (ref:evaluateLM) input objects and their description.
objectName objectClass desc sourceURL
abundTempLM lm A fitted model (of the `lm` class) of, for example, abundance as a function of temperature. NA

Provide a summary of user-visible parameters (Table \@ref(tab:moduleParams-evaluateLM))

(\#tab:moduleParams-evaluateLM)(\#tab:moduleParams-evaluateLM)List of (ref:evaluateLM) parameters and their description.
paramName paramClass default min max paramDesc
.useCache logical FALSE NA NA Should caching of events or module be used?

Events

The only event that happens (evaluate) tests if a LM is present at the end of a run, and presents all the plots and statistics described above.

Module outputs

Description of the module outputs (Table \@ref(tab:moduleOutputs-evaluateLM)).

(\#tab:moduleOutputs-evaluateLM)(\#tab:moduleOutputs-evaluateLM)List of (ref:evaluateLM) outputs and their description.
objectName objectClass desc
modDiagnostics list List of lm model diagnostics: prediction error (ResidualStandard Error, or RSE), how well the model fits the data(R-squared and adjusted R2, or R2), and plots residual vs fittedvalues, Normal Q-Q Plot, ans performs Cross-Validation.

Links to other modules

This module is stand-alone (although will not produce anything if the object lm is not created in the project), but has been created to be ran with the module speciesAbundTempLM as a way of demonstrating SpaDES, but can be expanded and used with other modules.

Getting help

  • Please use GitHub issues (https://github.com/tati-micheletti/evaluateLM/issues/new) if you encounter any problems in using this module.

Owner

  • Name: Tati Micheletti
  • Login: tati-micheletti
  • Kind: user

Citation (citation.bib) 

@Manual{,
  title = "evaluateLM Module v.1.0.0",
  author = "Tati Micheletti",
  organization = "University of British Columbia",
  address = "Victoria, BC",
  year = "2024",
  url = "https://github.com/tati-micheletti/evaluateLM",
}

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/render-module-rmd.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite