R/bd_search.R

In bangladesh: Provides Ready to Use Shapefiles for Geographical Map of Bangladesh

#' search for specific areas
#'
#' uses sf
#' @param searchFor search keyword
#' @param level administrative level of bangladesh. Should be one of: "country", "division", "district", "upazila","union'
#' @param as.is  boolean, if TRUE, matches exact keyword as given
#' @param  coordinates  boolean, if TRUE, returns centroids of searched areas (latitudes and longitudes)
#' @return  A data frame
#' @examples
#' bd_search("amtali", level = "union", as.is = TRUE, coordinates = TRUE)
#' @import sf
#' @export

bd_search <-
    function(searchFor, level = "division", as.is = FALSE, coordinates = FALSE){

        level = tolower(level)
        if(as.is){
            searchFor <- paste0("^", searchFor, "$")
        }
        switch (level,

                division = {

                    i <- with(bangladesh::area_names, grepl(searchFor, paste(Division), ignore.case = T))
                    r <- bangladesh::area_names[i,]
                    if(nrow(r) == 0){warning("No Result Found")}
                    if(!coordinates){
                        return(r)
                    }
                    else {
                        m <- merge(bangladesh::map_union,r)
                        c <- suppressWarnings(data.frame(st_coordinates(st_centroid(m))))
                        r <- with(m, data.frame(Division,District,Upazila, Union, lat = c[[2]], lon = c[[1]]))
                        return(r)
                    }
                },
                district = {
                    i <- with(bangladesh::area_names, grepl(searchFor, paste(District), ignore.case = T))
                    r <- bangladesh::area_names[i,]
                    if(nrow(r) == 0){warning("No Result Found")}
                    if(!coordinates){
                        return(r)
                    }
                    else {
                        m <- merge(bangladesh::map_union,r)
                        c <- suppressWarnings(data.frame(st_coordinates(st_centroid(m))))
                        r <- with(m, data.frame(Division,District,Upazila, Union, lat = c[[2]], lon = c[[1]]))
                        return(r)
                    }
                },
                upazila = {
                    i <- with(bangladesh::area_names, grepl(searchFor, paste(Upazila), ignore.case = T))
                    r <- bangladesh::area_names[i,]
                    if(nrow(r) == 0){warning("No Result Found")}
                    if(!coordinates){
                        return(r)
                    }
                    else {
                        m <- merge(bangladesh::map_union,r)
                        c <- suppressWarnings(data.frame(st_coordinates(st_centroid(m))))
                        r <- with(m, data.frame(Division,District,Upazila, Union, lat = c[[2]], lon = c[[1]]))
                        return(r)
                    }
                },
                union = {
                    i <- with(bangladesh::area_names, grepl(searchFor, paste(Union), ignore.case = T))
                    r <- bangladesh::area_names[i,]
                    if(nrow(r) == 0){warning("No Result Found")}

                    if(!coordinates){
                        return(r)
                    }
                    else {
                        m <- merge(bangladesh::map_union,r)
                        c <- suppressWarnings(data.frame(st_coordinates(st_centroid(m))))
                        r <- with(m, data.frame(Division,District,Upazila, Union, lat = c[[2]], lon = c[[1]]))
                        return(r)
                    }
                },
                all = {
                    i <- with(bangladesh::area_names, grepl(searchFor, paste(Division,District,Upazila, Union),
                                                            ignore.case = T))
                    r <- bangladesh::area_names[i,]
                    if(nrow(r) == 0){warning("No Result Found")}
                    if(!coordinates){
                        return(r)
                    }
                    else {
                        m <- merge(bangladesh::map_union,r)
                        c <- suppressWarnings(data.frame(st_coordinates(st_centroid(m))))
                        r <- with(m, data.frame(Division,District,Upazila, Union, lat = c[[2]], lon = c[[1]]))
                        return(r)
                    }
                },
                stop('incorrect level name. should be one of: "all", "division", "district", "upazila","union')
        )
    }