Skip to content

Commit

Permalink
add contribution section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vbaliga committed Dec 29, 2020
1 parent 5252918 commit f5d47e7
Show file tree
Hide file tree
Showing 60 changed files with 520 additions and 75 deletions.
7 changes: 7 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,13 @@ ggplot(motive_V_sf, aes(x = position_width, y = position_height)) +
```

## Contributing and/or raising Issues
We welcome feedback on bugs, improvements, and/or feature requests. Please
[see our Issues templates on GitHub](https://github.com/vbaliga/pathviewR/issues/new/choose) to make a bug
fix request or feature request.

To contribute code via a pull request, please consult our [Contributing Guide](https://github.com/vbaliga/pathviewR/blob/master/.github/CONTRIBUTING.md) first.

## Citation

The preferred way to cite `pathviewR` (but subject to change) is:
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,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-12-28 20:36:01"
#> - attr(*, "file_mtime")= POSIXct[1:1], format: "2020-12-28 22:11:27"
#> - 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 @@ -182,7 +182,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-12-28 20:36:01"
#> - attr(*, "file_mtime")= POSIXct[1:1], format: "2020-12-28 22:11:27"
#> - 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 @@ -298,6 +298,17 @@ ggplot(motive_V_sf, aes(x = position_width, y = position_height)) +

<img src="man/figures/README-motive_V_sf_pos-1.png" width="100%" />

## Contributing and/or raising Issues

We welcome feedback on bugs, improvements, and/or feature requests.
Please [see our Issues templates on
GitHub](https://github.com/vbaliga/pathviewR/issues/new/choose) to make
a bug fix request or feature request.

To contribute code via a pull request, please consult our [Contributing
Guide](https://github.com/vbaliga/pathviewR/blob/master/.github/CONTRIBUTING.md)
first.

## Citation

The preferred way to cite `pathviewR` (but subject to change) is:
Expand Down
11 changes: 8 additions & 3 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"codeRepository": "https://github.com/vbaliga/pathviewR",
"issueTracker": "https://github.com/vbaliga/pathviewR/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.9.4",
"version": "0.9.4.9000",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down Expand Up @@ -258,7 +258,7 @@
}
],
"readme": "https://github.com/vbaliga/pathviewR/blob/master/README.md",
"fileSize": "7986.507KB",
"fileSize": "8034.419KB",
"contIntegration": "https://codecov.io/gh/vbaliga/pathviewR?branch=master",
"developmentStatus": "https://www.repostatus.org/#active",
"citation": [
Expand Down Expand Up @@ -296,5 +296,10 @@
}
}
}
]
],
"review": {
"@type": "Review",
"url": "https://github.com/ropensci/software-review/issues/409",
"provider": "https://ropensci.org"
}
}
2 changes: 1 addition & 1 deletion docs/404.html

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

224 changes: 224 additions & 0 deletions docs/CONTRIBUTING.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/LICENSE.html

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

6 changes: 3 additions & 3 deletions 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/index.html

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

6 changes: 3 additions & 3 deletions docs/articles/managing-frame-gaps.html

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

0 comments on commit f5d47e7

Please sign in to comment.