Merge pull request #1 from moritzshore/dev

Prepared for first release

Author: moritzshore

NAMESPACE

@@ -15,6 +15,7 @@ importFrom(ncdf4,nc_open)
 importFrom(ncdf4,ncvar_get)
 importFrom(purrr,map)
 importFrom(readr,write_csv)
+importFrom(sf,read_sf)
 importFrom(sf,st_as_sf)
 importFrom(sf,st_bbox)
 importFrom(sf,st_buffer)

R/metnorenal3.R

@@ -9,15 +9,14 @@
 # server status:
 # https://status.met.no/
 
-# main function ##################
 
 #' Download data from the metno renanalysis project
 #'
 #' This function accesses the THREDDS server of met.no with download queries
 #' formatted from user input. (to be expanded upon)
 #'
 #' @param area (string) path to geo-referenced shapefile covering the desired area
-#' @param directory (string) path to desired working directory
+#' @param directory (string) path to desired working directory (default: working directory)
 #' @param fromdate (string) date and time for start of time series (ie. "2012-09-01 10:00:00")
 #' @param todate (string) date and time for end of time series (ie. "2013-09-01 10:00:00")
 #' @param area_buffer desired buffer around the provided shapefile (in meters, default 1500)
@@ -41,17 +40,21 @@
 #'
 get_metno_reanalysis3 <-
   function(area,
-           directory,
+           directory = NULL,
            fromdate =  "2012-09-01 10:00:00",
            todate = "2012-09-01 20:00:00",
            area_buffer = 1500,
            preview = TRUE
   ){
 
+    if(directory %>% is.null()){
+      directory <- getwd()
+    }
+
     # load in the shape file
     area <- sf::read_sf(area)
 
-    # supporting functions
+    # supporting functions ----
     nc_open_retry <- function(link) {
 
       nc_file <- tryCatch(expr = {ncdf4::nc_open(link)},
@@ -537,7 +540,7 @@ get_metno_reanalysis3 <-
       }
 
 
-    ### START MAIN FUNCTION
+    ### START MAIN FUNCTION ----
 
     # Add stop if nots (date wrong order)
 

README.md

@@ -2,6 +2,14 @@
 
 This R package hosts a variety of functions for NIBIO DMN Hydrology and Water Environment. If any bugs or problems are encountered, please open a new [issue](https://github.com/moritzshore/miljotools/issues) and we will attempt to resolve it.
 
+**Table of contents**
+
+1.  [Installing miljotools]
+
+2.  [MET Nordic Reanalysis Dataset]
+
+3.  [Add your own functions/code/workflows]
+
 ## Installing miljotools
 
 You can install and load `miljotools` from the GitHub repository using the following command:
@@ -35,7 +43,7 @@ To access the data for a specific region of the Nordics, you need to provide the
 
 1.  A path to a geo-referenced [shapefile](https://doc.arcgis.com/en/arcgis-online/reference/shapefiles.htm) (single polygon) of the desired area
 
-2.  A directory where you would like to save the data.
+2.  A directory where you would like to save the data (default: working directory)
 
 3.  A starting date and time
 
@@ -60,4 +68,6 @@ As output you will receive a seperate .csv file for each grid point. This .csv f
 
 **Note:** Currently, this function must request the data from met.no server on an hour-basis. This means that for each year to download, 8760 requests must be made to the server. This is rather slow, and as such the download can take quite a few hours. We are working with met.no to improve this situation.
 
-### 
+## Add your own functions/code/workflows
+
+If you have a function / code / workflow / etc. which you would like to add to this package, please contact the maintainer for developer access.