README is out of date

Open Beginner friendly
  • Is something wrong?
#8 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
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
julia
Domain
documentation

Research direction

Start with the README examples and compare them with the exported function names and signatures in the Julia code. Update the examples to match the current function names, arguments, and output, and document where users can obtain the canonical GeoPackage. Done when the README accurately describes these APIs, their output, and the required GeoPackage source.

Written by the indexing model from the issue text.

Description

  • The README shows multiple_location_comparison(reef_info) with one argument. The code defines multiple_location_comparison(locs, canonical_gpkg_path).
  • The README shows location_composition_summary. The exported function is location_composition_dataset.
  • The README's example output (timesteps 1994:2024, five taxa) no longer matches the code, which uses 1992:2025.
  • The canonical GeoPackage that multiple_location_comparison needs is not documented or included, so users can't tell where to get it.
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.