address editor comments

add citation; add info on how to request custom import functions via github issues; rebuild documentation
ropensci · Nov 18, 2020 · 688c198 · 688c198
1 parent 8162de3
commit 688c198
Show file tree

Hide file tree

Showing 12 changed files with 136 additions and 28 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -20,6 +20,7 @@ knitr::opts_chunk$set(
 [![R build status](https://github.com/vbaliga/pathviewR/workflows/R-CMD-check/badge.svg)](https://github.com/vbaliga/pathviewR/actions)
 [![Travis build status](https://travis-ci.org/vbaliga/pathviewR.svg?branch=master)](https://travis-ci.org/vbaliga/pathviewR)
 [![Codecov test coverage](https://codecov.io/gh/vbaliga/pathviewR/graph/badge.svg)](https://codecov.io/gh/vbaliga/pathviewR?branch=master)
+[![](https://badges.ropensci.org/409_status.svg)](https://github.com/ropensci/software-review/issues/409)
 <!-- badges: end -->
 
 `pathviewR` offers tools to import, clean, and visualize animal movement data
@@ -200,7 +201,9 @@ ggplot(motive_V_sf, aes(x = position_width, y = position_height)) +
 
 ## Citation
 
-TBD
+The preferred way to cite `pathviewR` (but subject to change) is:
+
+Baliga VB, Armstrong MS, Press ER (2020). _pathviewR: Tools to import, clean, and visualize animal movement data in R_. R package version 0.9.4, [https://github.com/vbaliga/pathviewR](https://github.com/vbaliga/pathviewR).
 
 ## License
 

diff --git a/README.md b/README.md
@@ -14,6 +14,7 @@ status](https://github.com/vbaliga/pathviewR/workflows/R-CMD-check/badge.svg)](h
 status](https://travis-ci.org/vbaliga/pathviewR.svg?branch=master)](https://travis-ci.org/vbaliga/pathviewR)
 [![Codecov test
 coverage](https://codecov.io/gh/vbaliga/pathviewR/graph/badge.svg)](https://codecov.io/gh/vbaliga/pathviewR?branch=master)
+[![](https://badges.ropensci.org/409_status.svg)](https://github.com/ropensci/software-review/issues/409)
 <!-- badges: end -->
 
 `pathviewR` offers tools to import, clean, and visualize animal movement
@@ -140,7 +141,7 @@ str(motive_data)
 #>  - attr(*, ".internal.selfref")=<externalptr> 
 #>  - attr(*, "pathviewR_steps")= chr "viewr"
 #>  - attr(*, "file_id")= chr "pathviewR_motive_example_data.csv"
-#>  - attr(*, "file_mtime")= POSIXct[1:1], format: "2020-11-18 02:53:24"
+#>  - attr(*, "file_mtime")= POSIXct[1:1], format: "2020-11-17 19:36:47"
 #>  - attr(*, "frame_rate")= num 100
 #>  - attr(*, "header")='data.frame':   11 obs. of  2 variables:
 #>   ..$ metadata: chr [1:11] "Format Version" "Take Name" "Take Notes" "Capture Frame Rate" ...
@@ -183,7 +184,7 @@ str(motive_allinone)
 #>  $ end_length_sign  : num [1:449] -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 ...
 #>  $ direction        : chr [1:449] "leftwards" "leftwards" "leftwards" "leftwards" ...
 #>  - attr(*, "file_id")= chr "pathviewR_motive_example_data.csv"
-#>  - attr(*, "file_mtime")= POSIXct[1:1], format: "2020-11-18 02:53:24"
+#>  - attr(*, "file_mtime")= POSIXct[1:1], format: "2020-11-17 19:36:47"
 #>  - attr(*, "frame_rate")= num 100
 #>  - attr(*, "header")='data.frame':   11 obs. of  2 variables:
 #>   ..$ metadata: chr [1:11] "Format Version" "Take Name" "Take Notes" "Capture Frame Rate" ...
@@ -301,7 +302,11 @@ ggplot(motive_V_sf, aes(x = position_width, y = position_height)) +
 
 ## Citation
 
-TBD
+The preferred way to cite `pathviewR` (but subject to change) is:
+
+Baliga VB, Armstrong MS, Press ER (2020). *pathviewR: Tools to import,
+clean, and visualize animal movement data in R*. R package version
+0.9.4, <https://github.com/vbaliga/pathviewR>.
 
 ## License
 

diff --git a/codemeta.json b/codemeta.json
@@ -258,7 +258,43 @@
     }
   ],
   "readme": "https://github.com/vbaliga/pathviewR/blob/master/README.md",
-  "fileSize": "9484.284KB",
+  "fileSize": "7986.961KB",
   "contIntegration": ["https://travis-ci.org/vbaliga/pathviewR", "https://codecov.io/gh/vbaliga/pathviewR?branch=master"],
-  "developmentStatus": "https://www.repostatus.org/#active"
+  "developmentStatus": "https://www.repostatus.org/#active",
+  "citation": [
+    {
+      "@type": "SoftwareSourceCode",
+      "datePublished": "2020",
+      "author": [
+        {
+          "@type": "Person",
+          "givenName": "Vikram B.",
+          "familyName": "Baliga",
+          "@id": "https://orcid.org/0000-0002-9367-8974"
+        },
+        {
+          "@type": "Person",
+          "givenName": "Melissa S.",
+          "familyName": "Armstrong",
+          "@id": "https://orcid.org/0000-0002-3059-0094"
+        },
+        {
+          "@type": "Person",
+          "givenName": "Eric R.",
+          "familyName": "Press",
+          "@id": "https://orcid.org/0000-0002-1944-3755"
+        }
+      ],
+      "name": "pathviewR: Tools to import, clean, and visualize animal movement data in R",
+      "url": "https://github.com/vbaliga/pathviewR",
+      "isPartOf": {
+        "@type": "PublicationIssue",
+        "datePublished": "2020",
+        "isPartOf": {
+          "@type": ["PublicationVolume", "Periodical"],
+          "name": "Github repository"
+        }
+      }
+    }
+  ]
 }
diff --git a/docs/articles/data-import-cleaning.html b/docs/articles/data-import-cleaning.html
diff --git a/docs/articles/managing-frame-gaps.html b/docs/articles/managing-frame-gaps.html
diff --git a/docs/articles/visual-perception-functions.html b/docs/articles/visual-perception-functions.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -5,7 +5,7 @@ articles:
   data-import-cleaning: data-import-cleaning.html
   managing-frame-gaps: managing-frame-gaps.html
   visual-perception-functions: visual-perception-functions.html
-last_built: 2020-11-12T07:06Z
+last_built: 2020-11-18T03:36Z
 urls:
   reference: https://vbaliga.github.io/pathviewR//reference
   article: https://vbaliga.github.io/pathviewR//articles

diff --git a/docs/reference/read_motive_csv.html b/docs/reference/read_motive_csv.html
diff --git a/inst/CITATION b/inst/CITATION
@@ -0,0 +1,28 @@
+year <- format(Sys.Date(), "%Y")
+note <- sprintf("R package version %s", meta$Version)
+
+bibentry(bibtype = "Manual",
+         title = "pathviewR: Tools to import, clean, and visualize animal movement data in R",
+         author = c(
+          person(
+             given = "Vikram B.",
+             family = "Baliga",
+             role = c("aut", "cre"),
+             comment = c(ORCID = "0000-0002-9367-8974")),
+          person(
+             given = "Melissa S.",
+             family = "Armstrong",
+             role = "aut",
+             comment = c(ORCID = "0000-0002-3059-0094")),
+          person(
+             given = "Eric R.",
+             family = "Press",
+             role = "aut",
+             comment = c(ORCID = "0000-0002-1944-3755"))
+          ),
+         year = year,
+         note = note,
+         publisher = "Github",
+         journal = "Github repository",
+         url = "https://github.com/vbaliga/pathviewR"
+         )
diff --git a/vignettes/data-import-cleaning.Rmd b/vignettes/data-import-cleaning.Rmd
@@ -32,9 +32,11 @@ Data can be imported via one of three ways:
 
 We will showcase examples from each of these methods in this section.
 
-Please feel free to reach out to the `pathviewR` authors should you have trouble
-with any of our data import options. We are happy to work with you to design
-custom `read_` functions for filetypes we have not encountered ourselves. 
+Please feel free to reach out to the `pathviewR` authors via 
+[our Github Issues page](https://github.com/vbaliga/pathviewR/issues/) 
+should you have trouble with any of our data import options. We are happy to
+work with you to design custom `read_` functions for file types we have not
+encountered ourselves. 
 
 We'll start by loading `pathviewR` and a few of the packages in the `tidyverse`.
 
@@ -141,6 +143,12 @@ test <-
   )
 ```
 
+We also welcome you to request custom data import functions, especially if
+`as_viewr()` does not fit your needs . We are interested in expanding our data
+import functions to accommodate additional file types. Please feel free to 
+[file a request for additional import functions](https://github.com/vbaliga/pathviewR/issues/new/choose) 
+via our Github Issues page.
+
 
 ## Data cleaning
 Data exported via either Motive or Flydra are not typically "tidy". Functions in