From 18699cafd8ee534af5f713e11f7070fe7a5d09cc Mon Sep 17 00:00:00 2001
From: andybeet <22455149+andybeet@users.noreply.github.com>
Date: Fri, 19 Nov 2021 14:59:19 -0500
Subject: [PATCH] changes ready for new version read me changes, DESCRIPTION
 changes, news.md

---
 .github/workflows/pkgdown.yml |  4 ++--
 DESCRIPTION                   |  2 +-
 R/get_locations.R             |  2 +-
 README.md                     |  9 +++++----
 man/get_locations.Rd          |  4 ++--
 news.md                       | 17 +++++++++++++++--
 6 files changed, 26 insertions(+), 12 deletions(-)

diff --git a/.github/workflows/pkgdown.yml b/.github/workflows/pkgdown.yml
index 066a271..dfa5e00 100644
--- a/.github/workflows/pkgdown.yml
+++ b/.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')
diff --git a/DESCRIPTION b/DESCRIPTION
index 768d15f..4712de7 100644
--- a/DESCRIPTION
+++ b/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 = "sean.lucey@noaa.gov", role = c("aut","cre")),
     person("Andy", "Beet", email = "andrew.beet@noaa.gov", role = c("aut")))
 Description: Pulls and processes commercial fishing data (US and NAFO)
diff --git a/R/get_locations.R b/R/get_locations.R
index 3ae2fad..cc0085d 100644
--- a/R/get_locations.R
+++ b/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)
diff --git a/README.md b/README.md
index 1a48626..7216120 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 # 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
 
@@ -10,7 +10,8 @@ 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
 
diff --git a/man/get_locations.Rd b/man/get_locations.Rd
index 0caf419..45fe1e0 100644
--- a/man/get_locations.Rd
+++ b/man/get_locations.Rd
@@ -8,7 +8,7 @@ get_locations(channel, sqlStatement = "select * from cfdbs.loc;")
 }
 \arguments{
 \item{channel}{DBI Object. Inherited from \link[DBI]{DBIConnection-class}. This object is used to connect
-to communicate with the database engine. (see \code{\link[dbutils]{connect_to_database}})}
+to communicate with the database engine. (see \code{\link{connect_to_database}})}
 
 \item{sqlStatement}{Character string. An sql statement (optional).
 If no \code{sqlStatement} is provided the default sql statement "\code{select * from cfdbs.loc}" is used}
@@ -37,7 +37,7 @@ channel <- connect_to_database(server="name_of_server",uid="individuals_username
 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)
diff --git a/news.md b/news.md
index 2cb38c6..b18353f 100644
--- a/news.md
+++ b/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