Add better titles for functions

R/agg_uniform_f.R

@@ -1,4 +1,4 @@
-#' @title agg_uniform
+#' @title Create a uniform aggregation raster
 #' @description
 #' This function is called by the agg_uniform module and creates a
 #' uniform aggregation raster.

R/agg_upload_f.R

@@ -1,4 +1,4 @@
-#' @title agg_upload
+#' @title Upload an aggregation raster
 #' @description
 #' This function is called by the agg_upload module and loads a
 #'  raster image.

R/agg_worldpop_f.R

@@ -1,7 +1,7 @@
-#' @title agg_worldpop
+#' @title Download an aggregation raster from WorldPop
 #' @description
 #' This function is called by the agg_worldpop module and downloads data on
-#' population density for a single country from worldpop
+#' population density for a single country from WorldPop
 #'
 #' @param shape sf. sf object containing the area of interest
 #' @param country_code character. ISO3 code of the country.

R/cov_access_f.R

@@ -1,4 +1,4 @@
-#' @title cov_access
+#' @title Download accessibility data from Malaria Atlas Project
 #' @description
 #' This function is called by the cov_access module and downloads data on
 #' accessibility using data from the Malaria Atlas Project.

R/cov_bioclim_f.R

@@ -1,4 +1,4 @@
-#' @title cov_bioclim
+#' @title Download bioclimatic data from Bioclim
 #' @description
 #' This function is called by the cov_bioclim module and downloads bioclimatic
 #' data on from Bioclim via geodata. It returns a list of SpatRasters for the

R/cov_landuse_f.R

@@ -1,4 +1,4 @@
-#' @title cov_landuse
+#' @title Download land use data from Copernicus Global Land Service
 #' @description
 #' This function is called by the cov_landuse module and downloads data on the
 #' percentage of land used for each category selected. Data is obtained at a

R/cov_nightlight_f.R

@@ -1,4 +1,4 @@
-#' @title cov_nightlight
+#' @title Download nighttime illumination data from using blackmarbler
 #' @description
 #' This function is called by the cov_nightlight module and downloads annual
 #' data on night time illumination from NASA (product ID VNP46A4) using the

R/cov_upload_f.R

@@ -1,4 +1,4 @@
-#' @title cov_upload
+#' @title Upload covariates
 #' @description
 #' This function is called by the cov_upload module. It loads raster images,
 #' checks their projection and transforms them if necessary, checks that they

R/cov_water_f.R

@@ -1,4 +1,4 @@
-#' @title cov_water
+#' @title Download data on the distance to water from ArcGIS
 #' @description
 #' This function is called by the cov_water module and downloads data on the
 #' distance to surface water from ArcGIS

R/pred_transfer_f.R

@@ -1,4 +1,4 @@
-#' @title pred_transfer
+#' @title Transfer predictions to a new country
 #' @description
 #' This function is called by the pred_transfer module and can transfer predictions
 #' generated from a model to a new area of interest.

R/prep_correlation_f.R

@@ -1,4 +1,4 @@
-#' @title prep_correlation
+#' @title Produce a correlation matrix of covariates
 #' @description
 #' Produce a correlation matrix of covariates
 #'

R/prep_scale_f.R

@@ -1,4 +1,4 @@
-#' @title prep_scale
+#' @title Scale the covariates
 #' @description This function is called by the prep_scale module and scales
 #' the values of a SpatRaster using a method equivalent to `terra::scale`
 #' @param covs SpatRaster. The covariates to be scaled.

R/prep_summary_f.R

@@ -1,4 +1,4 @@
-#' @title prep_summary
+#' @title Summarise properties of raster data
 #' @description
 #' Summarises the properties of a list of SpatRasters
 #'

R/resp_combine_f.R

@@ -1,4 +1,4 @@
-#' @title resp_combine
+#' @title Merge response data with a shapefile
 #' @description
 #' This function is called by the resp_combine module and merges response data
 #'  from a spreadsheet with boundary data from a shapefile into an sf object

R/resp_download_f.R

@@ -1,4 +1,4 @@
-#' @title resp_download
+#' @title Merge response data with a downloaded shapefile
 #' @description
 #' This function is called by the resp_download module and merges response data
 #'  from a spreadsheet with boundary data into an sf object

R/resp_edit_f.R

@@ -1,7 +1,7 @@
-#' @title resp_edit
+#' @title Remove polygons from response data
 #' @description
-#' This function is called by the resp_edit module and merges response data
-#'  from a spreadsheet with boundary data into an sf object
+#' This function is called by the resp_edit module and removes polygons from the
+#' response data depending on whether they are inside or outside of a polygon.
 #'
 #' @param shape sf. The sf object to be edited
 #' @param poly matrix. Containing latitude and longitude columns

R/resp_shape_f.R

@@ -1,4 +1,4 @@
-#' @title resp_shape
+#' @title Upload response data from a shapefile
 #' @description
 #' This function is called by the resp_shape module and loads a
 #'  shapefile into an sf object. Inspired by a function written by Paula Moraga

R/resp_simplify_f.R

@@ -1,4 +1,4 @@
-#' @title resp_simplify
+#' @title Simplify geometry of boundary data
 #' @description
 #' This function is called by the resp_simplify module and simplifies the
 #' geometry data in an sf object