From 66ab8957f2b97a66d8875d560d3447f79e76d2e6 Mon Sep 17 00:00:00 2001 From: Vijay Barve Date: Thu, 7 Dec 2023 16:06:22 -0800 Subject: [PATCH] V 0.2.37 Fixed documentation for CRAN submission --- DESCRIPTION | 4 ++-- NEWS | 3 ++- R/bdcomplete.R | 9 +++++---- R/gettaxo.R | 12 +++++++----- README.md | 6 +++--- man/bdcomplete.Rd | 9 +++++---- man/gettaxo.Rd | 12 +++++++----- 7 files changed, 31 insertions(+), 24 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index d1afdbe..049a36e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: bdvis Type: Package Title: Biodiversity Data Visualizations -Version: 0.2.36 -Date: 2023-12-04 +Version: 0.2.37 +Date: 2023-12-07 Authors@R: c( person("Vijay","Barve", ,"vijay.barve@gmail.com",role=c("aut","cre"), comment = c(ORCID = "0000-0002-4852-2567")), diff --git a/NEWS b/NEWS index cf21041..7f39424 100644 --- a/NEWS +++ b/NEWS @@ -1,9 +1,10 @@ -bdvis 0.2.36 +bdvis 0.2.37 =============== * Bug fixes in mapgrid * Funcation format_bdvis now handled bdsns * Package rgeos dependency removed * Finction mapgrid parameters mapadatabase and region deprecated +* Fixed documentaion bdvis 0.2.33 diff --git a/R/bdcomplete.R b/R/bdcomplete.R index cbc6468..5808437 100644 --- a/R/bdcomplete.R +++ b/R/bdcomplete.R @@ -24,10 +24,11 @@ #' throws an error. #'@param gridscale plot the map grids at specific degree scale. Default is 1. #' -#'@return data.frame with the columns \itemize{ \item{"Cell_id"}{ id of the cell} -#' \item{"nrec"}{ Number of records in the cell} \item{"Sobs"}{ Number of -#' Observed species} \item{"Sest"}{ Estimated number of species} -#' \item{"c"}{ Completeness ratio the cell} +#'@return data.frame with the columns \itemize{ \item "Cell_id" - id of the cell +#' \item"nrec" - Number of records in the cell +#' \item"Sobs" - Number of Observed species +#' \item"Sest" - Estimated number of species +#' \item"c" - Completeness ratio the cell #' #' Plots a graph of Number of species vs completeness } #'@examples \dontrun{ diff --git a/R/gettaxo.R b/R/gettaxo.R index 476b3ce..f1c2070 100644 --- a/R/gettaxo.R +++ b/R/gettaxo.R @@ -20,11 +20,13 @@ #'@param verbose If TRUE, displays each name string for which the higher #' taxonomy is sought #'@param progress If TRUE prints progress bar and messages on the consol. -#'@return indf with added / updated columns \itemize{ \item{"Kingdom"}{Kingdom -#' of the Scientific name} \item{"Phylum"}{Phylum of the Scientific name} -#' \item{"Order_"}{Order of the Scientific name} \item{"Family"}{Family of the -#' Scientific name} \item{"Genus"}{Genus of the Scientific name} } and also -#' saves a local copy of taxanomy downloaded for future use in taxo.db sqlite +#'@return indf with added / updated columns \itemize{ +#' \item "Kingdom" - Kingdom of the Scientific name +#' \item "Phylum" - Phylum of the Scientific name +#' \item "Order_" - Order of the Scientific name +#' \item "Family" - Family of the Scientific name +#' \item "Genus" - Genus of the Scientific name } and also +#' saves a local copy of taxonomy downloaded for future use in taxo.db sqlite #' file #'@examples \dontrun{ #'inat <- gettaxo(inat) diff --git a/README.md b/README.md index 23c4706..c7171ef 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,8 @@ bdsummary(inat) #### mapgrid ```r -mapgrid(inat,ptype="records",bbox=c(60,100,5,40),region=c("India")) -mapgrid(inat,ptype="records",bbox=c(60,100,5,40),region=c("India"),gridscale=0.1) +mapgrid(inat,ptype="records",bbox=c(60,100,5,40)) +mapgrid(inat,ptype="records",bbox=c(60,100,5,40),gridscale=0.1) ``` #### tempolar @@ -74,7 +74,7 @@ chronohorogram(inat) ```r comp=bdcomplete(inat,recs=5) -mapgrid(comp,ptype="complete",bbox=c(60,100,5,40),region=c("India")) +mapgrid(comp,ptype="complete",bbox=c(60,100,5,40)) ``` #### distrigraph diff --git a/man/bdcomplete.Rd b/man/bdcomplete.Rd index d11bc61..3da3949 100644 --- a/man/bdcomplete.Rd +++ b/man/bdcomplete.Rd @@ -16,10 +16,11 @@ throws an error.} \item{gridscale}{plot the map grids at specific degree scale. Default is 1.} } \value{ -data.frame with the columns \itemize{ \item{"Cell_id"}{ id of the cell} - \item{"nrec"}{ Number of records in the cell} \item{"Sobs"}{ Number of - Observed species} \item{"Sest"}{ Estimated number of species} - \item{"c"}{ Completeness ratio the cell} +data.frame with the columns \itemize{ \item "Cell_id" - id of the cell + \item"nrec" - Number of records in the cell + \item"Sobs" - Number of Observed species + \item"Sest" - Estimated number of species + \item"c" - Completeness ratio the cell Plots a graph of Number of species vs completeness } } diff --git a/man/gettaxo.Rd b/man/gettaxo.Rd index b334739..f1f13a6 100644 --- a/man/gettaxo.Rd +++ b/man/gettaxo.Rd @@ -17,11 +17,13 @@ taxonomy is sought} \item{progress}{If TRUE prints progress bar and messages on the consol.} } \value{ -indf with added / updated columns \itemize{ \item{"Kingdom"}{Kingdom - of the Scientific name} \item{"Phylum"}{Phylum of the Scientific name} - \item{"Order_"}{Order of the Scientific name} \item{"Family"}{Family of the - Scientific name} \item{"Genus"}{Genus of the Scientific name} } and also - saves a local copy of taxanomy downloaded for future use in taxo.db sqlite +indf with added / updated columns \itemize{ + \item "Kingdom" - Kingdom of the Scientific name + \item "Phylum" - Phylum of the Scientific name + \item "Order_" - Order of the Scientific name + \item "Family" - Family of the Scientific name + \item "Genus" - Genus of the Scientific name } and also + saves a local copy of taxonomy downloaded for future use in taxo.db sqlite file } \description{