Documentation, testing, README (#1)

DESCRIPTION

@@ -2,13 +2,18 @@ Package: whattheflux
 Type: Package
 Title: What the Package Does (Title Case)
 Version: 0.1.0
-Author: Who wrote it
-Maintainer: The package maintainer <[email protected]>
+Authors@R: c(
+    person("Ben", "Bond-Lamberty", email = "[email protected]",
+        role = "aut", comment = c(ORCID = "0000-0001-9525-4633")),
+    person("Stephanie", "Wilson", email = "[email protected]", 
+        role = "cre", comment = c(ORCID = "0000-0002-5484-0748")))
 Description: More about what it does (maybe more than one line)
     Use four spaces when indenting paragraphs within the Description.
+URL: https://compass.pnnl.gov
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+RoxygenNote: 7.2.3

NAMESPACE

@@ -1 +1,3 @@
-exportPattern("^[[:alpha:]]+")
+# Generated by roxygen2: do not edit by hand
+
+export(hello)

R/hello.R

@@ -1,6 +1,6 @@
 # Hello, world!
 #
-# This is an example function named 'hello' 
+# This is an example function named 'hello'
 # which prints 'Hello, world!'.
 #
 # You can learn more about package authoring with RStudio at:
@@ -13,6 +13,13 @@
 #   Check Package:             'Cmd + Shift + E'
 #   Test Package:              'Cmd + Shift + T'
 
+#' hello
+#'
+#' @return Nothing, just prints hello
+#' @export
+#'
+#' @examples
+#' hello()
 hello <- function() {
   print("Hello, world!")
 }

README.md

@@ -0,0 +1,27 @@
+
+# whattheflux
+
+<!-- badges: start -->
+[![R-CMD-check](https://github.com/COMPASS-DOE/whattheflux/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/COMPASS-DOE/whattheflux/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+The goal of whattheflux is to ...
+
+## Installation
+
+You can install the development version of whattheflux from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("COMPASS-DOE/whattheflux")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(whattheflux)
+## basic example code
+```
+

tests/testthat/test-hello.R

@@ -0,0 +1,3 @@
+test_that("multiplication works", {
+  expect_equal(2 * 2, 4)
+})

whattheflux.Rproj

@@ -18,3 +18,4 @@ StripTrailingWhitespace: Yes
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace,vignette