Merge pull request #57 from inbo/51-modify-reference-page-to-group-fu…

…nctions-by-family 51 modify reference page to group functions by family
inbo · Aug 8, 2024 · e80e1f5 · e80e1f5
2 parents 8b1ed36 + 020a7e0
commit e80e1f5
Show file tree

Hide file tree

Showing 38 changed files with 231 additions and 26 deletions.
diff --git a/R/CRS_extracter.R b/R/CRS_extracter.R
@@ -9,6 +9,8 @@
 #'
 #' @return A CRS object
 #'
+#' @family spatial
+#'
 #' @examples
 #' \dontrun{
 #' # Example of how to use the CRS_extracter function

diff --git a/R/apply_grtsdb.R b/R/apply_grtsdb.R
@@ -19,6 +19,8 @@
 #'
 #' @export
 #'
+#' @family spatial
+#'
 #' @examples
 #' \dontrun{
 #' # Preparation

diff --git a/R/boswachterijen.R b/R/boswachterijen.R
@@ -11,5 +11,6 @@
 #'   \item{telefoon}{Telefoon nr van de boswachter}
 #'   ...
 #' }
+#' @family dataset
 #' @source <https://www.who.int/teams/global-tuberculosis-programme/data>
 "boswachterijen"
diff --git a/R/calculate_polygon_centroid.R b/R/calculate_polygon_centroid.R
@@ -18,6 +18,8 @@
 #'
 #' @return A data frame with the unique identifier, latitude, longitude and uncertainty of the centroid
 #'
+#' @family spatial
+#'
 #' @examples
 #' \dontrun{
 #' # Example of how to use the calculate_polygon_centroid function

diff --git a/R/col_content_compare.R b/R/col_content_compare.R
@@ -10,6 +10,8 @@
 #' @param df2 A data frame
 #' @param col2 A column name of df2
 #'
+#' @family dataframe_comparison
+#'
 #' @return A list of values missing from the first column, missing from the second column,
 #' and the values that are in both columns.
 #'

diff --git a/R/colcompare.R b/R/colcompare.R
@@ -12,6 +12,8 @@
 #' a list of columns present in x but not in y and a list of columns
 #' present in y and not in x.
 #'
+#' @family dataframe_comparison
+#'
 #' @examples
 #' \dontrun{
 #' # create example dataframes

diff --git a/R/collect_osm_features.R b/R/collect_osm_features.R
@@ -31,6 +31,8 @@
 #' osm_polygons, osm_lines, osm_points. Each sf data frame contains the
 #' corresponding geometry types.
 #'
+#' @family spatial
+#'
 #' @details
 #' dplyr and osmdata are automatically installed when missing from your system.
 #'

diff --git a/R/download_dep_media.R b/R/download_dep_media.R
@@ -19,6 +19,8 @@
 #' If you are getting an Authorization Error (#403), this probably means your Agouti project has Restrict Images on. This needs to be turned off.
 #' If depID = "all" and favorite = TRUE, the function will download all favorited pictures in the whole dataset.
 #'
+#' @family download
+#'
 #' @returns Downloads the specified media files into the outputfolder
 #'
 #' @examples

diff --git a/R/download_gdrive_if_missing.R b/R/download_gdrive_if_missing.R
@@ -30,6 +30,8 @@
 #' @returns If the destination file was missing it is downloaded from the
 #' googledrive.
 #'
+#' @family download
+#'
 #' @examples
 #' \dontrun{
 #' # download newest version of the team charter

diff --git a/R/download_seq_media.R b/R/download_seq_media.R
@@ -17,6 +17,8 @@
 #' @details
 #' If you are getting an Authorization Error (#403), this probably means your Agouti project has Restrict Images on. This needs to be turned off.
 #'
+#' @family download
+#'
 #' @returns Downloads the specified media files into the outputfolder
 #'
 #' @examples

diff --git a/R/drg_example.R b/R/drg_example.R
@@ -8,5 +8,8 @@
 #'   \item{observations}{Observaties van de geselecteerde deployments}
 #'   \item{media}{Lijst van media-urls van de geselecteerde deployments}
 #'   }
+#'
+#' @family dataset
+#'
 #' @source <https://www.agouti.eu>
 "drg_example"
diff --git a/R/lib_crs.R b/R/lib_crs.R
@@ -8,6 +8,9 @@
 #'   \item{Proj4s}{Javascript Object Notation (JSON) of the CRS}
 #'   \item{ESPG}{EPSG code of the CRS}
 #' }
+#'
+#' @family library
+#'
 #' @source WGS <https://epsg.io/4326>
 #' @source BEL72 <https://epsg.io/31300>
 "lib_crs"
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -0,0 +1,27 @@
+pandoc: 2.9.2.1
+pkgdown: 2.1.0
+pkgdown_sha: ~
+last_built: 2024-07-31T18:46Z
+
+reference:
+- title: Spatial functions
+  contents:
+  - has_concept("spatial")
+- title: Dataframe comparison functions
+  contents:
+   - has_concept("dataframe_comparison")
+- title: Download functions
+  contents:
+  - has_concept("download")
+- title: Datasets
+  contents:
+  - has_concept("dataset")
+- title: Libraries
+  contents:
+  - has_concept("library")
+- title: Other functions
+  contents:
+  - lacks_concepts(c("spatial", "dataframe_comparison", "dataset", "library", "download"))
+
+build:
+  without_rdb: true
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 2.9.2.1
 pkgdown: 2.1.0
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-08-06T14:20Z
+last_built: 2024-08-07T11:00Z
diff --git a/docs/reference/CRS_extracter.html b/docs/reference/CRS_extracter.html
diff --git a/docs/reference/apply_grtsdb.html b/docs/reference/apply_grtsdb.html
diff --git a/docs/reference/boswachterijen.html b/docs/reference/boswachterijen.html
diff --git a/docs/reference/calculate_polygon_centroid.html b/docs/reference/calculate_polygon_centroid.html
diff --git a/docs/reference/col_content_compare.html b/docs/reference/col_content_compare.html
diff --git a/docs/reference/colcompare.html b/docs/reference/colcompare.html
diff --git a/docs/reference/collect_osm_features.html b/docs/reference/collect_osm_features.html
diff --git a/docs/reference/download_dep_media.html b/docs/reference/download_dep_media.html
diff --git a/docs/reference/download_gdrive_if_missing.html b/docs/reference/download_gdrive_if_missing.html
diff --git a/docs/reference/download_seq_media.html b/docs/reference/download_seq_media.html
diff --git a/docs/reference/drg_example.html b/docs/reference/drg_example.html