update doc, #19, #20, #21, #22

daijiang · Mar 30, 2021 · a735c77 · a735c77
1 parent f12862a
commit a735c77
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 34 deletions.
diff --git a/R/data_algae.R b/R/data_algae.R
@@ -31,9 +31,9 @@
 #' - `samplingProtocolVersion`: The NEON document number and version where detailed information regarding the sampling method used is available; format NEON.DOC.######vX.
 #' - `substratumSizeClass`: Size class of the substratum sampled.
 #' - `samplerType`: Type of sampler used to collect the sample.
-#' - `phytoDepth1`: First phytoplankton sample depth at sampling location
-#' - `phytoDepth2`: Second phytoplankton sample depth at sampling location
-#' - `phytoDepth3`: Third phytoplankton sample depth at sampling location
+#' - `phytoDepth1`: First phytoplankton sample depth (meter) at sampling location
+#' - `phytoDepth2`: Second phytoplankton sample depth (meter) at sampling location
+#' - `phytoDepth3`: Third phytoplankton sample depth (meter) at sampling location
 #' - `latitude`: The geographic latitude (in decimal degrees, WGS84) of the geographic center of the reference area.
 #' - `longitude`: The geographic longitude (in decimal degrees, WGS84) of the geographic center of the reference area.
 #' - `elevation`: Elevation (in meters) above sea level.

diff --git a/R/data_fish.R b/R/data_fish.R
@@ -11,6 +11,7 @@
 #' - `location_id`: Location id.
 #' - `siteID`: NEON site code.
 #' - `plotID`: Plot identifier (NEON site code_XXX).
+#' - `pointID`: Sampling point identifier.
 #' - `unique_sample_id`: Identity of unique samples, usually it has location and date information.
 #' - `observation_datetime`: Observation date and time.
 #' - `taxon_id`: Accepted species code, based on one or more sources.

diff --git a/R/data_macroinvertebrate.R b/R/data_macroinvertebrate.R
@@ -25,9 +25,9 @@
 #' - `substratumSizeClass`: Size class of the substratum sampled.
 #' - `neon_sample_id`: NEON sample ID.
 #' - `remarks`: Remarks of record.
-#' - `ponarDepth`: Depth of petite ponar sample.
-#' - `snagLength`: Length of snag sampled.
-#' - `snagDiameter`: Diameter of snag sampled.
+#' - `ponarDepth`: Depth (meter) of petite ponar sample.
+#' - `snagLength`: Length (centimeter) of snag sampled.
+#' - `snagDiameter`: Diameter (centimeter) of snag sampled.
 #' - `latitude`: The geographic latitude (in decimal degrees, WGS84) of the geographic center of the reference area.
 #' - `longitude`: The geographic longitude (in decimal degrees, WGS84) of the geographic center of the reference area.
 #' - `elevation`: Elevation (in meters) above sea level.

diff --git a/R/data_zooplankton.R b/R/data_zooplankton.R
@@ -23,7 +23,7 @@
 #' - `unit`: Unit of the values in the `value` column.
 #' - `release`: Version of data release by NEON.
 #' - `samplerType`:	Type of sampler used to collect the sample.
-#' - `towsTrapsVolumn`: Sample volume collected for zooplankton.
+#' - `towsTrapsVolumn`: Sample volume (liter) collected for zooplankton.
 #' - `latitude`: The geographic latitude (in decimal degrees, WGS84) of the geographic center of the reference area.
 #' - `longitude`: The geographic longitude (in decimal degrees, WGS84) of the geographic center of the reference area.
 #' - `elevation`: Elevation (in meters) above sea level.

diff --git a/R/neon_sites.R b/R/neon_sites.R
@@ -9,10 +9,10 @@
 #' - `Domain Name`: Full domain name.
 #' - `domainID`: Unique identifier of the NEON domain.
 #' - `State`: The state name of the site locates in.
-#' - `Latitude`: Latitide of the site.
-#' - `Longitude`: Longitude of the site.
+#' - `Latitude`: Latitide of the site  (in decimal degrees, WGS84).
+#' - `Longitude`: Longitude of the site (in decimal degrees, WGS84).
 #' - `Site Type`: The type of the site (e.g. Core Terrestrial).
-#' - `Site Subtype`: Second level site type.
-#' - `Site Host`: Host of the site.
+#' - `Site Subtype`: Second level site type, for aquatic sites only (e.g. Lake, Wadeable Stream, Non-wadeable Rive).
+#' - `Site Host`: Host organization of the site.
 #'
 "neon_sites"
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.11.4
 pkgdown: 1.6.1
 pkgdown_sha: ~
 articles: {}
-last_built: 2021-03-29T19:05Z
+last_built: 2021-03-30T03:47Z
 
diff --git a/docs/reference/data_algae.html b/docs/reference/data_algae.html
diff --git a/docs/reference/data_fish.html b/docs/reference/data_fish.html
diff --git a/docs/reference/data_macroinvertebrate.html b/docs/reference/data_macroinvertebrate.html
diff --git a/docs/reference/data_zooplankton.html b/docs/reference/data_zooplankton.html
diff --git a/docs/reference/neon_sites.html b/docs/reference/neon_sites.html
diff --git a/man/data_algae.Rd b/man/data_algae.Rd
diff --git a/man/data_fish.Rd b/man/data_fish.Rd
diff --git a/man/data_macroinvertebrate.Rd b/man/data_macroinvertebrate.Rd
diff --git a/man/data_zooplankton.Rd b/man/data_zooplankton.Rd
diff --git a/man/neon_sites.Rd b/man/neon_sites.Rd