Skip to content

Commit

Permalink
updating man pages to fix links to new docs site, plus other typos etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
robbriers committed Jun 25, 2019
1 parent 85b9594 commit 5c7c5e2
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 20 deletions.
4 changes: 2 additions & 2 deletions R/cde-class_and_methods.r
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@ trunc_char <- function(x, col_name_lengths){
#'
#' @param ... Other arguments passed on to individual methods. The only other
#' argument implemented at present is \code{scheme}. For \code{status} and
#' \code{objectives} this defines which colour scheme to use with plots.It
#' \code{objectives} data this defines which colour scheme to use with plots. It
#' defaults to a viridis-based scheme (\code{scheme="vir"}). Alternatively, the
#' colours specified in the WFD document ca be used by specifying
#' colours specified in the WFD document can be used by specifying
#' \code{scheme="wfd"}.
#'
#' @importFrom graphics barplot
Expand Down
2 changes: 1 addition & 1 deletion R/get_measures.r
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#' @return An object of class \code{cde_df} containing the details
#' of the measures put in place to try and improve water quality.
#' For details of the meaning of the the different columns returned,
#' see \url{https://ropensci.github.io/cde/articles/cde-output-reference.html}.
#' see \url{https://docs.ropensci.org/cde/articles/cde-output-reference.html}.

#'
#' @export get_measures
Expand Down
2 changes: 1 addition & 1 deletion R/get_objectives.r
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
#' @return An object of class \code{cde_df} containing the details
#' of the objectives set for the specified set of waterbodies.
#' For details of the meaning of the the different columns returned,
#' see \url{https://ropensci.github.io/cde/articles/cde-output-reference.html}.
#' see \url{https://docs.ropensci.org/cde/articles/cde-output-reference.html}.
#'
#' @export get_objectives
#'
Expand Down
2 changes: 1 addition & 1 deletion R/get_pa.r
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#' @return An object of class \code{cde_df} containing the details of the
#' Protected Areas associated with the waterbodies.
#' For details of the meaning of the the different columns returned,
#' see \url{https://ropensci.github.io/cde/articles/cde-output-reference.html}.
#' see \url{https://docs.ropensci.org/cde/articles/cde-output-reference.html}.

#'
#' @export get_pa
Expand Down
7 changes: 3 additions & 4 deletions R/get_rnag.r
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#' Catchment (\code{OC}) or River Basin District (\code{RBD}) level
#' downloads, waterbody \code{type} can also be specified to allow
#' extraction of specific waterbody types (River, Lake etc).
#' Data is presented at the level of individual elements that are the
#' Data are presented at the level of individual elements that are the
#' reasons for not achieving good status.
#
#' @param ea_name A string representing the description (\code{name} for
Expand All @@ -33,8 +33,7 @@
#' @param endyr The data can be extracted for specific years using the
#' \code{startyr} and \code{endyr} arguments. The \code{endyr} should
#' only be specified if \code{startyr} is also included, otherwise it
#' is ignored and all years are returned. RNAG data are only available from
#' 2013 onwards.
#' returns an error. RNAG data are only available from 2013 onwards.
#'
#' @param type Type of waterbody to be extracted. For Operational/Management
#' catchment level or RBD level queries, the data can also be subset by
Expand All @@ -45,7 +44,7 @@
#' Reasons for Not Achieving Good Status for the specified combination
#' of criteria.
#' For details of the meaning of the the different columns returned,
#' see \url{https://ropensci.github.io/cde/articles/cde-output-reference.html}.
#' see \url{https://docs.ropensci.org/cde/articles/cde-output-reference.html}.

#'
#' @export get_rnag
Expand Down
2 changes: 1 addition & 1 deletion R/get_status.r
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
#' @return An object of class \code{cde_df} containing the classification
#' details for the specified combination of criteria.
#' For details of the meaning of the the different columns returned,
#' see \url{https://ropensci.github.io/cde/articles/cde-output-reference.html}.
#' see \url{https://docs.ropensci.org/cde/articles/cde-output-reference.html}.

#'
#' @export get_status
Expand Down
2 changes: 1 addition & 1 deletion man/get_measures.Rd

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

2 changes: 1 addition & 1 deletion man/get_objectives.Rd

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

2 changes: 1 addition & 1 deletion man/get_pa.Rd

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

7 changes: 3 additions & 4 deletions man/get_rnag.Rd

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

2 changes: 1 addition & 1 deletion man/get_status.Rd

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

4 changes: 2 additions & 2 deletions man/plot.cde_df.Rd

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

0 comments on commit 5c7c5e2

Please sign in to comment.