diff --git a/R/CRS_extracter.R b/R/CRS_extracter.R index 881802a..ff74165 100644 --- 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 index 1ee5b9e..6e8f592 100644 --- 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 index 90e87ea..75520f0 100644 --- a/R/boswachterijen.R +++ b/R/boswachterijen.R @@ -11,5 +11,6 @@ #' \item{telefoon}{Telefoon nr van de boswachter} #' ... #' } +#' @family dataset #' @source "boswachterijen" diff --git a/R/calculate_polygon_centroid.R b/R/calculate_polygon_centroid.R index 15b5f4f..207030e 100644 --- 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 index 330d134..ecc5589 100644 --- 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 index b76c134..a979b1c 100644 --- 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 index b7fc130..f126b2d 100644 --- 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 index 7527894..e29bd03 100644 --- 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 index 4a6f54d..5a0ec18 100644 --- 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 index dedb20f..9997235 100644 --- 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 index a548770..11e3ba4 100644 --- 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 "drg_example" diff --git a/R/lib_crs.R b/R/lib_crs.R index a1293a9..68c396d 100644 --- 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 #' @source BEL72 "lib_crs" diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..2ca5dbe --- /dev/null +++ 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 index 323f5b6..039ab6f 100644 --- 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 index 5b4e80b..3669f98 100644 --- a/docs/reference/CRS_extracter.html +++ b/docs/reference/CRS_extracter.html @@ -66,6 +66,13 @@

Arguments

Value

A CRS object

+
+
+

See also

+

Author

diff --git a/docs/reference/apply_grtsdb.html b/docs/reference/apply_grtsdb.html index 67358a9..9b46912 100644 --- a/docs/reference/apply_grtsdb.html +++ b/docs/reference/apply_grtsdb.html @@ -77,6 +77,13 @@

Arguments

Details

A function to apply grtsdb to a custom perimeter

GRTSdb is automatically installed when missing from your system.

+
+
+

See also

+

Author

diff --git a/docs/reference/boswachterijen.html b/docs/reference/boswachterijen.html index 044947b..ba8b5d3 100644 --- a/docs/reference/boswachterijen.html +++ b/docs/reference/boswachterijen.html @@ -74,6 +74,11 @@

boswachterijenSource

https://www.who.int/teams/global-tuberculosis-programme/data

+
+

See also

+

Other dataset: +drg_example

+
+
+

See also

+

Author

diff --git a/docs/reference/col_content_compare.html b/docs/reference/col_content_compare.html index a19ee9d..9a716ae 100644 --- a/docs/reference/col_content_compare.html +++ b/docs/reference/col_content_compare.html @@ -75,6 +75,11 @@

Arguments

Value

A list of values missing from the first column, missing from the second column, and the values that are in both columns.

+
+
+

See also

+

Other dataframe_comparison: +colcompare()

Author

diff --git a/docs/reference/colcompare.html b/docs/reference/colcompare.html index 5fa0a18..76ebed9 100644 --- a/docs/reference/colcompare.html +++ b/docs/reference/colcompare.html @@ -63,6 +63,11 @@

Arguments

Value

a list of columns present in x but not in y and a list of columns present in y and not in x.

+
+
+

See also

+

Other dataframe_comparison: +col_content_compare()

Author

diff --git a/docs/reference/collect_osm_features.html b/docs/reference/collect_osm_features.html index 62ec871..5d0c59a 100644 --- a/docs/reference/collect_osm_features.html +++ b/docs/reference/collect_osm_features.html @@ -99,6 +99,13 @@

Value

Details

A function to collect custom osm features for a project

dplyr and osmdata are automatically installed when missing from your system.

+
+
+

See also

+

Author

diff --git a/docs/reference/download_dep_media.html b/docs/reference/download_dep_media.html index 613b906..56bc549 100644 --- a/docs/reference/download_dep_media.html +++ b/docs/reference/download_dep_media.html @@ -87,6 +87,12 @@

Value

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. If depID = "all" and favorite = TRUE, the function will download all favorited pictures in the whole dataset.

+
+
+

See also

+

Author

diff --git a/docs/reference/download_gdrive_if_missing.html b/docs/reference/download_gdrive_if_missing.html index ac868e5..2766496 100644 --- a/docs/reference/download_gdrive_if_missing.html +++ b/docs/reference/download_gdrive_if_missing.html @@ -91,6 +91,12 @@

Details

'show, modify and delete all drive files' option is selected. If the error persists please create a new issue on the github page.

+
+
+

See also

+

Other download: +download_dep_media(), +download_seq_media()

Author

diff --git a/docs/reference/download_seq_media.html b/docs/reference/download_seq_media.html index f95a81a..5686e79 100644 --- a/docs/reference/download_seq_media.html +++ b/docs/reference/download_seq_media.html @@ -76,6 +76,12 @@

Value

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.

+
+
+

See also

+

Author

diff --git a/docs/reference/drg_example.html b/docs/reference/drg_example.html index 5069600..255cd88 100644 --- a/docs/reference/drg_example.html +++ b/docs/reference/drg_example.html @@ -64,6 +64,11 @@

Format

Source

https://www.agouti.eu

+
+

See also

+

Other dataset: +boswachterijen

+
- - - - - - - - + + @@ -77,11 +69,11 @@

All functions colcompare()

- - - + @@ -93,10 +85,42 @@

All functions download_seq_media()

+ + + + + + + + + + + + + @@ -105,10 +129,6 @@

All functions label_converter()

- -
-

All functions

+

Spatial functions

CRS_extracter()

CRS_extracter

-

UUID_List()

-

UUID list generator

apply_grtsdb()

apply grtsdb

-

boswachterijen

-

Boswachterijen

calculate_polygon_centroid()

Calculate the centroid of a polygon

-

check()

-

Check

-

cleanup_sqlite()

+

collect_osm_features()

cleanup sqlite

+

collect OpenStreetMaps features

+

Dataframe comparison functions

+

+

col_content_compare()

Compare column contents of two dataframes

Columnname comparison

-

collect_osm_features()

-

collect OpenStreetMaps features

+
+

Download functions

+

+

download_dep_media()

Download deployment media

Download sequence media

+

Datasets

+

+
+

boswachterijen

+

Boswachterijen

drg_example

drg_example

+

Libraries

+

+
+

lib_crs

+

Lib CRS

+

Other functions

+

+
+

UUID_List()

+

UUID list generator

+

check()

+

Check

+

cleanup_sqlite()

+

cleanup sqlite

install_sp()

label converter

-

lib_crs

-

Lib CRS