Skip to content

Commit

Permalink
add cran badge and install info
Browse files Browse the repository at this point in the history
  • Loading branch information
vbaliga committed May 6, 2021
1 parent 0f549b6 commit 527cc8b
Show file tree
Hide file tree
Showing 14 changed files with 66 additions and 37 deletions.
15 changes: 11 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ knitr::opts_chunk$set(
[![R build status](https://github.com/ropensci/pathviewr/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/pathviewr/actions)
[![Codecov test coverage](https://codecov.io/gh/ropensci/pathviewr/graph/badge.svg)](https://codecov.io/gh/ropensci/pathviewr?branch=master)
[![](https://badges.ropensci.org/409_status.svg)](https://github.com/ropensci/software-review/issues/409)
[![DOI](https://zenodo.org/badge/268906628.svg)](https://zenodo.org/badge/latestdoi/268906628)
[![DOI](https://zenodo.org/badge/268906628.svg)](https://zenodo.org/badge/latestdoi/268906628)
[![CRAN status](https://www.r-pkg.org/badges/version/pathviewr)](https://CRAN.R-project.org/package=pathviewr)
<!-- badges: end -->

`pathviewr` offers tools to import, clean, and visualize movement data,
Expand All @@ -35,9 +36,15 @@ perception of visual stimuli.

## Installation

This package can be installed via:
``` r
#install.packages("devtools") # if devtools is not installed
You can install `pathviewr` from CRAN via:

``` {r install_cran, eval = FALSE}
install.packages("pathviewr")
```

Or to get the latest (developmental) version through GitHub, use:

``` {r install_github, eval = FALSE}
devtools::install_github("ropensci/pathviewr")
```

Expand Down
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ status](https://github.com/ropensci/pathviewr/workflows/R-CMD-check/badge.svg)](
coverage](https://codecov.io/gh/ropensci/pathviewr/graph/badge.svg)](https://codecov.io/gh/ropensci/pathviewr?branch=master)
[![](https://badges.ropensci.org/409_status.svg)](https://github.com/ropensci/software-review/issues/409)
[![DOI](https://zenodo.org/badge/268906628.svg)](https://zenodo.org/badge/latestdoi/268906628)
[![CRAN
status](https://www.r-pkg.org/badges/version/pathviewr)](https://CRAN.R-project.org/package=pathviewr)
<!-- badges: end -->

`pathviewr` offers tools to import, clean, and visualize movement data,
Expand All @@ -28,10 +30,15 @@ subject position to estimate perception of visual stimuli.

## Installation

This package can be installed via:
You can install `pathviewr` from CRAN via:

``` r
install.packages("pathviewr")
```

Or to get the latest (developmental) version through GitHub, use:

``` r
#install.packages("devtools") # if devtools is not installed
devtools::install_github("ropensci/pathviewr")
```

Expand Down Expand Up @@ -111,7 +118,7 @@ has passed through the pipeline.
``` r
## Check out the data's structure before cleaning and wrangling:
str(motive_data)
#> tibble [934 × 26] (S3: tbl_df/tbl/data.frame)
#> tibble[,26] [934 x 26] (S3: tbl_df/tbl/data.frame)
#> $ frame : int [1:934] 72210 72211 72212 72213 72214 72215 72216 72217 72218 72219 ...
#> $ time_sec : num [1:934] 722 722 722 722 722 ...
#> $ device02_rotation_x : num [1:934] 0.1346 0.0819 0.2106 0.1961 0.1305 ...
Expand Down Expand Up @@ -141,7 +148,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: "2021-03-15 16:34:52"
#> - attr(*, "file_mtime")= POSIXct[1:1], format: "2021-05-06 08:57:14"
#> - 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" ...
Expand All @@ -158,7 +165,7 @@ str(motive_data)

## Check out the data's structure after cleaning and wrangling:
str(motive_allinone)
#> tibble [449 × 24] (S3: tbl_df/tbl/data.frame)
#> tibble[,24] [449 x 24] (S3: tbl_df/tbl/data.frame)
#> $ frame : int [1:449] 72213 72214 72215 72216 72217 72218 72219 72220 72221 72222 ...
#> $ time_sec : num [1:449] 722 722 722 722 722 ...
#> $ subject : chr [1:449] "device02" "device02" "device02" "device02" ...
Expand All @@ -184,7 +191,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: "2021-03-15 16:34:52"
#> - attr(*, "file_mtime")= POSIXct[1:1], format: "2021-05-06 08:57:14"
#> - 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" ...
Expand Down Expand Up @@ -321,6 +328,6 @@ clean, and visualize animal movement data in R*. R package version

## License

GPL (\>= 3) + file LICENSE
GPL (&gt;= 3) + file LICENSE

🐢
13 changes: 10 additions & 3 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@
}
],
"readme": "https://github.com/ropensci/pathviewr/blob/master/README.md",
"fileSize": "11637.19KB",
"fileSize": "10753.257KB",
"contIntegration": "https://codecov.io/gh/ropensci/pathviewr?branch=master",
"developmentStatus": "https://www.repostatus.org/#active",
"citation": [
Expand Down Expand Up @@ -307,7 +307,8 @@
},
"relatedLink": [
"https://docs.ropensci.org/pathviewr",
"https://docs.ropensci.org/pathviewr/"
"https://docs.ropensci.org/pathviewr/",
"https://CRAN.R-project.org/package=pathviewr"
],
"keywords": [
"movement-data",
Expand All @@ -322,5 +323,11 @@
"trajectory-analysis",
"trajectories"
],
"releaseNotes": "https://github.com/ropensci/pathviewr/blob/master/NEWS.md"
"releaseNotes": "https://github.com/ropensci/pathviewr/blob/master/NEWS.md",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
}
}
2 changes: 1 addition & 1 deletion docs/articles/data-import-cleaning.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/managing-frame-gaps.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/visual-perception-functions.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 527cc8b

Please sign in to comment.