Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.

Commit

Permalink
Merge pull request #6 from cct-datascience/success-nick
Browse files Browse the repository at this point in the history
Success section
  • Loading branch information
Aariq authored Mar 18, 2024
2 parents c710846 + c4e341a commit 8c6a3fb
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion proposal/success.Qmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,36 @@ editor:
<!--
Projects should have a definition of done that is measurable, and a thorough understanding going in of what the risks are to delivery
-->
In order to understand and evaluate the success of the {geotargets} project, it is worthwhile visiting our definitions of done and success, as well as exploring future work, and potential risks to the project.


## Definition of done
<!--
What does success look like?
-->

Success in the geotargets project looks like supporting fundamental geospatial raster and vector operations for the {terra} and {sf} packages. We will include examples of using these targets workflows for {terra} and {sf} in the form of vignettes, as well as link to existing repositories that will

## Measuring success
<!--
How will we know when success is achieved, what markers can we use along the way
-->
We will use github issues to identify key tasks that require completing. For example, identifying target components for rasters and vectors for the terra package were outlined in https://github.com/njtierney/geotargets/issues/12. The pull requests that resolved this were linked in the issue.

We will ensure the package is has high test coverage of over 80%. This will make the package easier to maintain, as any breaking changes will be identified early.
We will use github actions to ensure `geotargets` can be installed on windows, macOS, and linux. High test coverage and github actions together will indicate to users this package is reliable and well maintained, which will hopefully improve trust and user takeup.

Another way we will measure success is by community uptake - if the project is used by the community then we will know that the project is successful, because it means it is solving a real need for the people using it. We can measure this success via a few metrics, github stars, downloads from CRAN, and citations to the software.

We will regularly engage with the community to see that we are meeting their needs in geospatial

## Future work
<!--
How could this be extended / developed in the future by yourself and/or the community in general?
-->

This work could be extended in the future by developing new geospatial target factories for other spatial formats. For example, there are formats such as geoarrow, vapour, and geoparquet.

## Key risks
<!--
What sort of things could come up that can delay or break the project?
Expand All @@ -34,4 +48,10 @@ What sort of things could come up that can delay or break the project?
- [ ] Tooling & Technology
- [ ] Costs
-->
-->

Some of the risks in this project are potential changes in geospatial technology. Although it is unlikely that projects such as GDAL will produce breaking changes, if they do, then we might need to make substantial changes.

We have decided to provide support for currently maintained geospatial projects. For example, we do not provide support for the raster R package (https://github.com/rspatial/raster), because it has been superceded by the terra R package. Many people still use the raster package, but we have decided to avoid the risk of supporting raster as it is no longer actively maintained.

Another potential risk is key team members having other commitments arise that mean they cannot work on the project anymore. We can protect against these by having more than one key team member who can contribute to the work. This will reduce our "bus factor". We will also adopt professional standards for managing our project on git and github. This means that we will regularly push our work onto github, so the work will not be at risk of not being available by way of only being on someone's specific machine.

0 comments on commit 8c6a3fb

Please sign in to comment.