inbo / inbo/ClimateCastR

Create function [climate_match]

Open
#22 0 comments 0 reactions 1 assignee View on GitHub

@soriadelva is already working on this.

Since Aug 13, 2024.

Dominant language
R
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

climate_match

Function that calculates the % climate match of a species with each climatic zone defined in the Köppen-Geiger climate classification map. It's output is the dataset currently labeled as 'unfiltered'. This function will be very similar to the climate matching part in the climate_match() function currently stored under trias, with the following additions:

  • A buffer will be used around each occurrence point to calculate number of records in each climatic zone (see #12)
  • The user will be able to filter the records used for climate matching (e.g., only use those from a specific region or time period, see #5)
  • In case a certain amount of records falls in the marine realm, a pop-up should occur to ask whether the species is marine. If so, an error should be given: Currently climate_matching cannot be performed for marine species (see #6 )
  • A column displaying the amount of climate matching relative to the region with the highest match will be added (see #7)

Checklist

  • maak een nieuw R-bestand
  • sla het R bestand op onder ./R met filenaam is gelijk aan functienaam
  • voorzie een functie titel met #' op regel 1 van je script
  • voorzie een auteur met #' @author
  • voorzie een beschrijving met #' @description
  • voorzie uitleg over de input parameter(s) met #' @param name
  • voorzie uitleg over de output van de functie met #' @returns
  • voorzie minstens 1 voorbeeld van het gebruik van de functie dmv #' @examples
  • voorzie de export - tag dmv #' @export (#14)
  • voer usethis::use_package("packagename", min_version = TRUE) uit in de console voor iedere package die je gebruikt.
  • voer roxygen2::roxygenise() uit in de console
  • voer devtools::check() uit in de console
  • los eventuele errors, warnings en notes1 op
  • maak een pull request met @soriadelva of @SanderDevisscher en eventueel andere relevante gebruikers als reviewer.

1in de mate van het mogelijke

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.