Document the modelling choices in `processing.jl`

Open Beginner friendly
  • Is something wrong?
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
julia
Domain
documentation

Research direction

Start by reading processing.jl, then check README and Endpoints.md to see how the existing documentation is organized. Document the four modelling choices listed in the issue and include their reasoning where it can be established; done when readers can find these choices and their effects described in the project documentation.

Written by the indexing model from the issue text.

Description

These are not bugs, but they affect results and aren't documented in the README or Endpoints.md:

  • Acropora cover is split 50/50 between Tabular_Acropora and Corymbose_Acropora.
  • "Other", "Unidentified" and "Rare groups" are dropped, so the five groups sum to less than total hard coral cover.
  • Multiple depth series at a reef are averaged with equal weight.
  • Years with no data are returned as missing.

Could these be documented, ideally with the reasoning?

Dominant language
Julia
Stars
1
Forks
0
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from open-AIMS/ReefMonitoring-DataClient

All issues in open-AIMS/ReefMonitoring-DataClient

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.