Skip to content

Commit 333f4b2

Browse files
fkeckfkeck
committed
Update Doc
1 parent 5cf5bb4 commit 333f4b2

18 files changed

+55
-31
lines changed

‎DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Description:
88
Also implements some functions to convert more complex objects (like contourlines, graphs, ...) into sp object.
99
Depends:
1010
R (>= 3.0.2),
11+
Imports:
12+
geosphere,
1113
rleafmap,
1214
igraph,
1315
sp
14-
Imports:
15-
geosphere
1616
License: GPL-2
1717
LazyData: true

‎NAMESPACE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Generated by roxygen2 (4.0.1): do not edit by hand
1+
# Generated by roxygen2 (4.1.1): do not edit by hand
22

33
export(arcAngle)
44
export(choroMap)
@@ -7,7 +7,7 @@ export(graph2sp)
77
export(heatMap)
88
export(netMap)
99
export(quickMap)
10-
import(geosphere)
1110
import(igraph)
1211
import(rleafmap)
1312
import(sp)
13+
importFrom(geosphere,gcIntermediate)

‎R/choroMap.R

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
#' @param alpha a numeric to control the transparency.
1010
#' @param popup a character vector providing popup content.
1111
#' @param col a vector of color usually generated by color palettes functions.
12+
#' @param ... additional arguments which can be passed to \code{\link[rleafmap]{writeMap}}.
1213
#'
1314
#' @export
1415
choroMap <- function(x, col.by, breaks = 5, alpha = 1, col = NULL, popup = NULL, ...){

‎R/epimap-package.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' @import sp
44
#' @import rleafmap
55
#' @import igraph
6-
#' @import geosphere
6+
#' @importFrom geosphere gcIntermediate
77
#'
88
#' @name epimap
99
#' @docType package

‎R/graph2sp.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ graph2sp <- function(x, edges = c("lines", "gc", "arc"), alpha = 45){
6161
#' Compute the arc between two points with its angular distance.
6262
#'
6363
#' @param pt1 a numeric vector of length 2 giving the coordinates (x and y) of the first point.
64-
#' @param pt1 a numeric vector of length 2 giving the coordinates (x and y) of the second point.
64+
#' @param pt2 a numeric vector of length 2 giving the coordinates (x and y) of the second point.
6565
#' @param alpha a numeric giving the value of the central angle (angular distance in degrees).
6666
#' @param n the number of points to generate.
6767
#' @param inv a logical. Since there are two solutions, can be used to get the second arc.

‎R/heatMap.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
#' Use \code{\link[rleafmap]{bmSource}} to get a list of preconfigured servers.
99
#' @param show.contour a logical stating whether contour lines should be displayed.
1010
#' @param show.gradient a logical stating whether the heatmap should be displayed.
11-
#' @param n.levels if \code{show.contour} is \code{TRUE}, number of contour levels.
12-
#' @param ... other argument to be passed to \code{\link[rleafmap]{writeMap}}
11+
#' @param nlevels if \code{show.contour} is \code{TRUE}, number of contour levels.
12+
#' @param ... other arguments to be passed to \code{\link[rleafmap]{writeMap}}
1313
#'
1414
#' @export
1515
heatMap <- function(x, bm = "stamen.toner.lite",

‎R/netMap.R

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@
77
#'
88
#' @param x an \code{igraph} object with at least two vertices attributes \code{"lon"} and \code{"lat"}
99
#' giving the longitude and the latitude of each vertex respectively.
10+
#' @param v.size a numeric vector indicating vertices size.
11+
#' @param v.col a vector of R colors to use for the vertices.
1012
#' @param bm a character string giving the base map tiles server adress.
1113
#' Use \code{\link[rleafmap]{bmSource}} to get a list of preconfigured servers.
14+
#' @param ... additional arguments which can be passed to \code{\link[rleafmap]{writeMap}}.
1215
#'
1316
#' @export
1417
netMap <- function(x, v.size = 5, v.col = 2, bm = "cartodb.darkmatter.nolab", ...){
@@ -28,7 +31,7 @@ netMap <- function(x, v.size = 5, v.col = 2, bm = "cartodb.darkmatter.nolab", ..
2831
net.map.pt2 <- spLayer(net.sp[[1]], popup = net.sp[[1]]$name,
2932
fill.col = v.col, fill.alpha = 0.2,
3033
size = v.size * 3, stroke = FALSE)
31-
net.map.li <- spLayer(net.sp[[2]], stroke.lwd=1, stroke.col = "white")
34+
net.map.li <- spLayer(net.sp[[2]], stroke.lwd = 1, stroke.col = "white")
3235

3336
writeMap(bm, net.map.pt, net.map.pt2, net.map.li, ...)
3437
}

‎R/quickMap.R

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
#' Only relevant with \code{SpatialPointsDataFrame}
1010
#' @param alpha a numeric to control the transparency.
1111
#' @param popup a character vector providing popup content.
12+
#' @param ... other arguments to be passed to \code{\link[rleafmap]{writeMap}}
1213
#'
1314
#' @export
1415
quickMap <- function(x, col.by = "", size.by = "", alpha = 1, popup = "", ...){

‎man/arcAngle.Rd

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/graph2sp.R
23
\name{arcAngle}
34
\alias{arcAngle}
45
\title{Arc of a Circle}
@@ -8,7 +9,7 @@ arcAngle(pt1, pt2, alpha = 45, n = 100, inv = FALSE)
89
\arguments{
910
\item{pt1}{a numeric vector of length 2 giving the coordinates (x and y) of the first point.}
1011

11-
\item{pt1}{a numeric vector of length 2 giving the coordinates (x and y) of the second point.}
12+
\item{pt2}{a numeric vector of length 2 giving the coordinates (x and y) of the second point.}
1213

1314
\item{alpha}{a numeric giving the value of the central angle (angular distance in degrees).}
1415

‎man/cholera.Rd

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/epimap-package.R
23
\docType{data}
34
\name{cholera}
45
\alias{cholera}

‎man/choroMap.Rd

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/choroMap.R
23
\name{choroMap}
34
\alias{choroMap}
45
\title{Basic interactive choropleth}
@@ -15,9 +16,11 @@ choroMap(x, col.by, breaks = 5, alpha = 1, col = NULL, popup = NULL,
1516

1617
\item{alpha}{a numeric to control the transparency.}
1718

19+
\item{col}{a vector of color usually generated by color palettes functions.}
20+
1821
\item{popup}{a character vector providing popup content.}
1922

20-
\item{col}{a vector of color usually generated by color palettes functions.}
23+
\item{...}{additional arguments which can be passed to \code{\link[rleafmap]{writeMap}}.}
2124
}
2225
\description{
2326
This function can be use to quickly generate a choropleth

‎man/contour2sp.Rd

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/contour2sp.R
23
\name{contour2sp}
34
\alias{contour2sp}
45
\title{Contour Lines to SpatialLinesDataFrame}

‎man/epimap.Rd

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/epimap-package.R
3+
\docType{package}
4+
\name{epimap}
5+
\alias{epimap}
6+
\alias{epimap-package}
7+
\title{epimap}
8+
\description{
9+
epimap
10+
}
11+

‎man/graph2sp.Rd

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/graph2sp.R
23
\name{graph2sp}
34
\alias{graph2sp}
45
\title{Convert a graph into Spatial objects}

‎man/heatMap.Rd

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/heatMap.R
23
\name{heatMap}
34
\alias{heatMap}
45
\title{Interactive heatmaps and contour lines}
@@ -16,9 +17,9 @@ Use \code{\link[rleafmap]{bmSource}} to get a list of preconfigured servers.}
1617

1718
\item{show.gradient}{a logical stating whether the heatmap should be displayed.}
1819

19-
\item{n.levels}{if \code{show.contour} is \code{TRUE}, number of contour levels.}
20+
\item{nlevels}{if \code{show.contour} is \code{TRUE}, number of contour levels.}
2021

21-
\item{...}{other argument to be passed to \code{\link[rleafmap]{writeMap}}}
22+
\item{...}{other arguments to be passed to \code{\link[rleafmap]{writeMap}}}
2223
}
2324
\description{
2425
This is a wrapping function to create interactive

‎man/mapR.Rd

-10
This file was deleted.

‎man/netMap.Rd

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/netMap.R
23
\name{netMap}
34
\alias{netMap}
45
\title{Interactive network on a map}
@@ -9,8 +10,14 @@ netMap(x, v.size = 5, v.col = 2, bm = "cartodb.darkmatter.nolab", ...)
910
\item{x}{an \code{igraph} object with at least two vertices attributes \code{"lon"} and \code{"lat"}
1011
giving the longitude and the latitude of each vertex respectively.}
1112

13+
\item{v.size}{a numeric vector indicating vertices size.}
14+
15+
\item{v.col}{a vector of R colors to use for the vertices.}
16+
1217
\item{bm}{a character string giving the base map tiles server adress.
1318
Use \code{\link[rleafmap]{bmSource}} to get a list of preconfigured servers.}
19+
20+
\item{...}{additional arguments which can be passed to \code{\link[rleafmap]{writeMap}}.}
1421
}
1522
\description{
1623
This is a wrapping function to create interactive

‎man/quickMap.Rd

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
% Generated by roxygen2 (4.0.1): do not edit by hand
1+
% Generated by roxygen2 (4.1.1): do not edit by hand
2+
% Please edit documentation in R/quickMap.R
23
\name{quickMap}
34
\alias{quickMap}
45
\title{Quickly generate an interactive map}
@@ -16,6 +17,8 @@ Only relevant with \code{SpatialPointsDataFrame}}
1617
\item{alpha}{a numeric to control the transparency.}
1718

1819
\item{popup}{a character vector providing popup content.}
20+
21+
\item{...}{other arguments to be passed to \code{\link[rleafmap]{writeMap}}}
1922
}
2023
\description{
2124
This function can be used to quickly generate interactive maps

0 commit comments

Comments
 (0)