usethis setup

fchen365 · Dec 6, 2019 · 63779a8 · 63779a8
1 parent 8dd2719
commit 63779a8
Show file tree

Hide file tree

Showing 8 changed files with 661 additions and 675 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -0,0 +1,3 @@
+^surf\.Rproj$
+^\.Rproj\.user$
+^LICENSE\.md$
diff --git a/.gitignore b/.gitignore
@@ -34,3 +34,4 @@ vignettes/*.pdf
 
 # Shiny token, see https://shiny.rstudio.com/articles/shinyapps.html
 rsconnect/
+.Rproj.user
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -0,0 +1,13 @@
+Package: surf
+Title: What the Package Does (One Line, Title Case)
+Version: 0.0.0.9000
+Authors@R: 
+    person(given = "First",
+           family = "Last",
+           role = c("aut", "cre"),
+           email = "[email protected]",
+           comment = c(ORCID = "YOUR-ORCID-ID"))
+Description: What the package does (one paragraph).
+License: GPL-3
+Encoding: UTF-8
+LazyData: true
diff --git a/LICENSE b/LICENSE
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/NAMESPACE b/NAMESPACE
@@ -0,0 +1,2 @@
+# Generated by roxygen2: fake comment so roxygen2 overwrites silently.
+exportPattern("^[^\\.]")
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
+
 # surf
-The statistical utility for RBP functions (SURF)
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of surf is to ...
+
+## Installation
+
+You can install the released version of surf from [CRAN](https://CRAN.R-project.org) with:
+
+``` r
+install.packages("surf")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(surf)
+## basic example code
+```
+
diff --git a/surf.Rproj b/surf.Rproj
@@ -0,0 +1,21 @@
+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,3 +34,4 @@ vignettes/*.pdf

		# Shiny token, see https://shiny.rstudio.com/articles/shinyapps.html
		rsconnect/
		.Rproj.user
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Generated by roxygen2: fake comment so roxygen2 overwrites silently.
		exportPattern("^[^\\.]")