changes ready for new version

read me changes, DESCRIPTION changes, news.md

.github/workflows/pkgdown.yml

@@ -1,4 +1,4 @@
-name: deploy to github pages
+name: gh-pages
 
 on:
   push:
@@ -22,7 +22,7 @@ jobs:
         run: |
             brew install gdal
             brew install proj
-            
+
       - name: Query dependencies
         run: |
           install.packages('remotes')

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: comlandr
 Title: Pulls and processes commercial fishing data
-Version: 0.2.0
+Version: 0.3.0
 Authors@R: c(person("Sean", "Lucey", email = "[email protected]", role = c("aut","cre")),
     person("Andy", "Beet", email = "[email protected]", role = c("aut")))
 Description: Pulls and processes commercial fishing data (US and NAFO)

R/get_locations.R

@@ -33,7 +33,7 @@
 #' get_locations(channel)
 #'
 #' # extracts subset of location information. Statistical area, and 10 minute square based
-#' on custom sql statement
+#' # on custom sql statement
 #' channel <- connect_to_database(server="name_of_server",uid="individuals_username")
 #' sqlStatement <- "select area TENMSQ from cfdbs.loc;"
 #' get_locations(channel,sqlStatement)

README.md

@@ -1,16 +1,17 @@
 # comlandr
 
-![deploy to github pages](https://github.com/NOAA-EDAB/comlandr/workflows/deploy%20to%20github%20pages/badge.svg)
-![Install on windows](https://github.com/NOAA-EDAB/comlandr/workflows/Install%20on%20windows/badge.svg)
-![gitleaks](https://github.com/NOAA-EDAB/comlandr/workflows/gitleaks/badge.svg)
+[![gh-pages](https://github.com/NOAA-EDAB/comlandr/workflows/gh-pages/badge.svg)](https://github.com/NOAA-EDAB/comlandr/actions)
+
+[![gitleaks](https://github.com/NOAA-EDAB/comlandr/workflows/gitleaks/badge.svg)](https://github.com/NOAA-EDAB/comlandr/actions)
 
 Pull and process fishing data
 
 To use this package you will need:
 
 1. To be behind the NEFSC firewall
 2. Permissions to access the required server : a username and password.
-3. Oracle's instant Client installed
+3. Permission to access the required database
+4. Oracle's instant Client installed
 
 ## Usage
 

news.md

@@ -1,15 +1,28 @@
-# comlandr 0.1.0
+# comlandr 0.3.0
 
-Initial release 
+Standalone functionality for pulling NAFO data
+
+`get_foreign_data` - pulls data from NAFOs STATLANT 21B database
 
 # comlandr 0.2.0
 
 Added supporting `get` functions to pull information from supporting oracle tables
 
 `get_areas` - pull stat area, region, NAFO codes
+
 `get_gears` - pull gear type, codes, description
+
 `get_vessels` - pull tonnage, crew size
+
 `get_locations` - pull lat, lon, 10 min sq.
+
 `get_ports` - pull port names and locations
+
 `get_species` - pull species name, market code information
+
 `get_species_itis` - pull species itis information
+
+
+# comlandr 0.1.0
+
+Initial release