inbo / fistools

Repo containing widely used data & functions of the FIS team
https://inbo.github.io/fistools/
Other
1 stars 0 forks source link

Modify reference page to group functions by family #51

Closed SanderDevisscher closed 2 months ago

SanderDevisscher commented 2 months ago

To improve function findability I suggest we try to group functions by theme. This should be achievable by adding the following code to pkdown.yml.

reference:
- title: Thema A functions
  contents:
  - has_concept("A")
- title: Thema B functions
  contents:
   - has_concept("B")
- title: Other functions
  contents:
  - other

based on: https://github.com/r-lib/pkgdown/issues/954

Currently only 1 function has a family tag, namely col_content_compare has the column comparison family tag.

TODO:

I suggest adding the following families:

function name function title family?
CRS_extracter() CRS_extracter spatial
UUID_List() UUID list generator other
apply_grtsdb() apply grtsdb spatial
boswachterijen Boswachterijen dataset
calculate_polygon_centroid() Calculate the centroid of a polygon spatial
check() Check other
cleanup_sqlite() cleanup sqlite other
col_content_compare() Compare column contents of two dataframes column comparison
colcompare() Columnname comparison column comparison
collect_osm_features() collect OpenStreetMaps features spatial
download_dep_media() Download deployment media download
download_gdrive_if_missing() Download gdrive if missing download
download_seq_media() Download sequence media download
drg_example drg_example dataset
install_sp() install sp other
label_converter() label converter other
lib_crs Lib CRS library

@soriadelva want to try ?

SanderDevisscher commented 2 months ago

@soriadelva I'll make an attempt