Merge pull request #286 from ropensci/markdown-docs

markdown docs
ropensci · Aug 30, 2024 · b579339 · b579339
2 parents 62f277e + d865366
commit b579339
Show file tree

Hide file tree

Showing 45 changed files with 67 additions and 57 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -22,7 +22,6 @@ Authors@R: c(person("Carl", "Boettiger",
                     comment = c(ORCID = "0000-0001-6619-9874")))
 URL: https://docs.ropensci.org/rfishbase/, https://github.com/ropensci/rfishbase
 BugReports: https://github.com/ropensci/rfishbase/issues
-LazyData: true
 Depends:
     R (>= 4.0)
 Imports:
@@ -40,6 +39,9 @@ Suggests:
     rmarkdown,
     knitr,
     covr,
-    spelling
+    spelling,
+    curl
 RoxygenNote: 7.3.1
 Language: en-US
+Roxygen: list(markdown = TRUE)
+
diff --git a/R/load_taxa.R b/R/load_taxa.R
@@ -16,15 +16,20 @@ load_taxa_ <- function(server = c("fishbase", "sealifebase"),
 
 #' load_taxa
 #' 
+#' Show scientific classification of taxa
+#' Note: species_names() is an alias for load taxa.
 #' @param server Either "fishbase" (the default) or "sealifebase"
 #' @param version the version of the database you want. Will default to the
 #' latest available; see [available_releases()].
 #' @param ... for compatibility with previous versions
+#' @aliases species_names
 #' @return the taxa list
 #' @export
 load_taxa <- memoise::memoise(load_taxa_)
 
 
+species_names <- memoise::memoise(load_taxa_)
+
 
 dummy_fn <- function(f) {
   # CRAN check doesn't recognize memoise use in the above and throws note:

diff --git a/R/species.R b/R/species.R
@@ -22,3 +22,4 @@
 #' 
 #' }
 species <- endpoint("species")
+
diff --git a/man/brains.Rd b/man/brains.Rd
diff --git a/man/c_code.Rd b/man/c_code.Rd
diff --git a/man/common_names.Rd b/man/common_names.Rd
diff --git a/man/common_to_sci.Rd b/man/common_to_sci.Rd
diff --git a/man/country.Rd b/man/country.Rd
diff --git a/man/countrysub.Rd b/man/countrysub.Rd
diff --git a/man/countrysubref.Rd b/man/countrysubref.Rd
diff --git a/man/diet.Rd b/man/diet.Rd
diff --git a/man/ecology.Rd b/man/ecology.Rd
diff --git a/man/ecosystem.Rd b/man/ecosystem.Rd
diff --git a/man/estimate.Rd b/man/estimate.Rd
diff --git a/man/faoareas.Rd b/man/faoareas.Rd
diff --git a/man/fb_tables.Rd b/man/fb_tables.Rd
diff --git a/man/fb_tbl.Rd b/man/fb_tbl.Rd
diff --git a/man/fecundity.Rd b/man/fecundity.Rd
diff --git a/man/fooditems.Rd b/man/fooditems.Rd
diff --git a/man/genetics.Rd b/man/genetics.Rd
diff --git a/man/introductions.Rd b/man/introductions.Rd
diff --git a/man/larvae.Rd b/man/larvae.Rd
diff --git a/man/length_freq.Rd b/man/length_freq.Rd
diff --git a/man/length_length.Rd b/man/length_length.Rd
diff --git a/man/length_weight.Rd b/man/length_weight.Rd
diff --git a/man/load_taxa.Rd b/man/load_taxa.Rd
diff --git a/man/maturity.Rd b/man/maturity.Rd
diff --git a/man/morphology.Rd b/man/morphology.Rd
diff --git a/man/morphometrics.Rd b/man/morphometrics.Rd
diff --git a/man/oxygen.Rd b/man/oxygen.Rd
diff --git a/man/popchar.Rd b/man/popchar.Rd
diff --git a/man/popgrowth.Rd b/man/popgrowth.Rd
diff --git a/man/popqb.Rd b/man/popqb.Rd
diff --git a/man/predators.Rd b/man/predators.Rd
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,3 +22,4 @@
		#'
		#' }
		species <- endpoint("species")