Skip to content

Commit

Permalink
Merge branch 'dev' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
dramanica committed Dec 8, 2023
2 parents 3bf64b7 + 93d5956 commit 6cd7ee5
Show file tree
Hide file tree
Showing 43 changed files with 30 additions and 100 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master, fix_check]
branches: [main, fix_check]
pull_request:
branches: [main, master]

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master, dev]
branches: [main, dev]
pull_request:
branches: [main, master, dev]
branches: [main, dev]
release:
types: [published]
workflow_dispatch:
Expand Down
10 changes: 5 additions & 5 deletions R/accessors.R
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ setMethod("getGraph", "gData", function(x, ...) {
#' @param \dots other arguments passed to other methods (currently unused).
#' @return A data.frame with the requested nodes attributes. Nodes are
#' displayed in rows, variables in columns.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso Most other accessors are documented in \linkS4class{gGraph} and
#' \linkS4class{gData} manpages.\cr
#' @keywords utilities methods
Expand Down Expand Up @@ -221,7 +221,7 @@ setMethod("getNodes", "gData", function(x, ...) {
#'
#' - \code{matId}: a matrix with two columns giving couples of node indices
#' forming edges.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso Most other accessors are documented in \linkS4class{gGraph}
#' manpage.\cr
#'
Expand Down Expand Up @@ -305,7 +305,7 @@ setMethod("getEdges", "gGraph", function(x, res.type = c("asIs", "matNames", "ma
#' \code{costs[i]} is the weight of the i-th edge.
#' @param \dots other arguments passed to other methods (currently unused).
#' @return A \linkS4class{gGraph} object with newly added or removed edges.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso \code{\link{geo.add.edges}} and \code{\link{geo.remove.edges}} to
#' interactively add or remove edges in a \linkS4class{gGraph} object. \cr
#'
Expand Down Expand Up @@ -400,7 +400,7 @@ setMethod("setEdges", "gGraph", function(x, add = NULL, remove = NULL, costs = N
#'
#' - \code{vector}: a vector of weights; this output matches matrix outputs of
#' \code{\link{getEdges}}.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso Most other accessors are documented in \linkS4class{gGraph}
#' manpage.\cr
#' @keywords utilities methods
Expand Down Expand Up @@ -517,7 +517,7 @@ setMethod("getData", "gData", function(x, ...) {
#' with different colors. See details.
#' @param \dots other arguments passed to other methods.
#' @return A vector of characters being valid colors.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities methods
#' @export
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/auxil.R
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
#' \code{segments} function.
#' @return For \code{hasCost}, a logical value is returned. \code{geo.segments}
#' returns NULL.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities methods
#' @name auxiliary
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/buffer.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
#'
#' - \code{gData}: a \linkS4class{gData} object including all the nodes of the
#' buffers.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities methods
#' @name buffer
#' @examples
Expand Down
4 changes: 2 additions & 2 deletions R/classes.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ NULL
#'
#' Note that none of these is mandatory: \code{new("gGraph")} would work, and
#' create an empty \code{gGraph} object.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso Related classes are:\cr % - \code{\linkS4class{graphNEL}}
#' (graph package): slot \code{@graph} in \code{gGraph}.\cr
#' @keywords classes spatial graphs
Expand Down Expand Up @@ -139,7 +139,7 @@ setClass(
#' an empty \code{gGraph} object. Also note that a finer matching of locations
#' against the nodes of a \code{gGraph} object can be achieved after creating
#' the object, for instance using the \code{closestNode} method.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso Related class:\cr - \code{\linkS4class{gGraph}}\cr
#' @examples
#'
Expand Down
2 changes: 1 addition & 1 deletion R/closestNode.R
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
#' If \code{x} is a \linkS4class{gData} object: a \linkS4class{gData} object
#' with matching nodes stored in the \code{@nodes.id} slot. Note that previous
#' content of \code{@nodes.id} will be erased.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso \code{\link{geo.add.edges}} and \code{\link{geo.remove.edges}} to
#' interactively add or remove edges in a \linkS4class{gGraph} object.
#' @keywords utilities methods
Expand Down
2 changes: 1 addition & 1 deletion R/connectivity.R
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
#'
#' - \code{isConnected}: a single logical value, being TRUE if nodes of the
#' object form a connected set.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities methods
#' @name connectivity
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/dijkstra.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
#' \code{sp.between} function (see \code{?sp.between}), with a class attribute
#' set to "gPath", and an additional slot 'xy' containing geographic
#' coordinates of the nodes involved in the paths.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords methods spatial
#' @examples
#' \dontrun{
Expand Down
2 changes: 1 addition & 1 deletion R/dropDead.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#' @param thres a numeric value indicating the threshold cost for an edge to be
#' removed. All costs strictly greater than \code{thres} will be removed.
#' @return A \linkS4class{gGraph} object.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities methods
#' @export
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/extractFromLayer.R
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
#' - \code{gData}: a \linkS4class{gData} object with new data associated to
#' locations (\code{@data} slot). New information is merge to older information
#' according to the type of data being stored. \cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso \code{\link{findLand}}, to find which locations are on land.
#' @keywords utilities methods
#' @name extractFromLayer
Expand Down
2 changes: 1 addition & 1 deletion R/findLand.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#' - \code{gGraph}: a \linkS4class{gGraph} object with a new node attribute,
#' possibly added to previously existing node attributes (\code{@nodes.attr}
#' slot).\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso \code{\link{extractFromLayer}}, to retrieve any information from a
#' GIS shapefile.
#' @keywords utilities methods
Expand Down
4 changes: 2 additions & 2 deletions R/interact.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ NULL
#' a character string can be provided, corresponding to one of the following
#' datasets: 'rawgraph.10k', rawgraph.40k'.
#' @return A \linkS4class{gGraph} object with newly added or removed edges.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso \code{\link{setEdges}} to non-interactively add or remove edges in
#' a \linkS4class{gGraph} object.
#' @keywords utilities
Expand Down Expand Up @@ -276,7 +276,7 @@ geo.remove.edges <- function(x, mode = c("points", "area")) {
#' reference when re-adding edges. If a character string is provided, it must
#' match one of the following dataset: 'rawgraph.10k', 'rawgraph.40k'.
#' @return A \linkS4class{gGraph} object with modified node attributes.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities
#' @examples
#' \dontrun{
Expand Down
2 changes: 1 addition & 1 deletion R/isInArea.R
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
#'
#' - \code{character}: a vector of characters corresponding to the names of the
#' nodes falling within the area.\cr
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities methods
#' @export
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/makeGrid.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#' @param lon.range,lat.range vectors of length two giving the range covered by
#' the grid, in longitude and latitude, respectively.
#' @return A \linkS4class{gGraph} object.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @keywords utilities methods
#' @export
#' @examples
Expand Down
4 changes: 2 additions & 2 deletions R/plot.R
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
#' \code{reset=TRUE} will prevent points to be redrawn.
#' @param \dots further arguments passed to the generic methods (plot, points,
#' and segments, respectively).
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso - Different functions to explore these plots:\cr
#' \code{\link{geo.zoomin}}, \code{\link{geo.zoomout}},
#' \code{\link{geo.slide}}, \code{\link{geo.back}}.\cr
Expand Down Expand Up @@ -563,7 +563,7 @@ plotEdges <- function(x, useCosts = NULL, col = "black", lwd = 1,
#' when replotting (TRUE, default), or not (FALSE). In any case,
#' \code{reset=TRUE} will prevent points to be redrawn.
#' @param \dots further arguments passed to \code{points}.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso - Different functions to explore these plots:\cr
#' \code{\link{geo.zoomin}}, \code{\link{geo.zoomout}},
#' \code{\link{geo.slide}}, \code{\link{geo.back}}, \code{\link{geo.bookmark}},
Expand Down
2 changes: 1 addition & 1 deletion R/setCosts.R
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
#' @param \dots additional parameters to be passed to \code{FUN}.
#' @return A \linkS4class{gGraph} object with the newly defined costs used as
#' weightings of edges.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso \code{\link{dropDeadEdges}}, to get rid of edge whose cost is below
#' a given threshold. \code{\link{geo.add.edges}} to add edges to a
#' \linkS4class{gGraph} object.
Expand Down
2 changes: 1 addition & 1 deletion R/setDistCosts.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#' @return For the \linkS4class{gGraph} method, a \linkS4class{gGraph} object
#' with appropriate weights. Note that former weights will be removed from the
#' object.
#' @author Thibaut Jombart (\email{t.jombart@@imperial.ac.uk})

#' @seealso The \code{\link{getCosts}} accessor, returning costs of the edges
#' of a \linkS4class{gGraph} object in different ways.\cr
#' @keywords utilities methods
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can install the development version of `geoGraph` from [GitHub](https://gith

``` r
install.packages("devtools")
devtools::install_github("thibautjombart/geoGraph")
devtools::install_github("EvolEcolGroup/geograph/")
```

## How the package works
Expand Down
3 changes: 0 additions & 3 deletions man/auxiliary.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/buffer.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/closestNode.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/combineCosts.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/connectivity.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/dijkstra-methods.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/dropDeadEdges.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/extractFromLayer.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/findLand.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/gData-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/gGraph-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/geo.add.edges.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/geo.change.attr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/getColors.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/getCosts.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/getEdges.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6cd7ee5

Please sign in to comment.