basic actions / readme

.Rbuildignore

@@ -1,3 +1,4 @@
 ^LICENSE\.md$
 ^.*\.Rproj$
-^\.Rproj\.user$
+^\.Rproj\.user$
+^README\.Rmd$

.github/.gitignore

@@ -0,0 +1,2 @@
+*.html
+.DS_Store

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,53 @@
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R CMD Check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macOS-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,  r: 'release'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - name: Check
+        run: rcmdcheck::rcmdcheck(args = c("--ignore-vignettes", "--no-manual", "--no-tests"), 
+                                  build_args = c("--no-build-vignettes"), 
+                                  error_on = "error", 
+                                  check_dir = "check")
+        shell: Rscript {0}
+
+      - name: Upload check results
+        if: failure()
+        uses: actions/upload-artifact@master
+        with:
+          name: results
+          path: check

DESCRIPTION

@@ -17,9 +17,9 @@ Imports:
     arrow,
     dplyr,
     glue,
-    sf,
     jsonlite,
     nhdplusTools,
+    sf
 License: GPL (>= 3)
 Encoding: UTF-8
 LazyData: true

README.Rmd

@@ -0,0 +1,55 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# hfsubsetR
+
+<!-- badges: start -->
+[![Dependencies](https://img.shields.io/badge/dependencies-6/70-orange?style=flat)](#)
+<!-- badges: end -->
+
+The goal of `hfsubsetR` is to extract hydrofabric subsets from cloud or local archives built in `lynker-spatial`.
+
+## Installation
+
+You can install the development version of `hfsubsetR` from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("lynker-spatial/hfsubsetR")
+```
+
+## Remote Access
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r remote}
+## basic example code
+```
+
+## Local
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r local}
+## basic example code
+```
+
+## Hydrolocation Extraction
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r hydrolocation}
+## basic example code
+```

README.md

@@ -0,0 +1,46 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# hfsubsetR
+
+<!-- badges: start -->
+
+[![Dependencies](https://img.shields.io/badge/dependencies-6/70-orange?style=flat)](#)
+<!-- badges: end -->
+
+The goal of `hfsubsetR` is to extract hydrofabric subsets from cloud or
+local archives built in `lynker-spatial`.
+
+## Installation
+
+You can install the development version of `hfsubsetR` from
+[GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("lynker-spatial/hfsubsetR")
+```
+
+## Remote Access
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+## basic example code
+```
+
+## Local
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+## basic example code
+```
+
+## Hydrolocation Extraction
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+## basic example code
+```