v0.1.0

.Rbuildignore

@@ -1,2 +1,20 @@
+^CODE_OF_CONDUCT\.md$
+^LICENSE\.md$
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^working$
+^\.github$
+^data-raw$
+data.csv
+vignettes/*\.Rmd\.orig
+vignettes/precompile\.R
+^docs$
+^cache$
+^pkgdown$
+^cran-comments\.md$
+^CRAN-RELEASE$
+^doc$
+^Meta$
+^CRAN-SUBMISSION$
+^README\.Rmd$
+^.mailmap$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,25 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who 
+contribute through reporting issues, posting feature requests, updating documentation,
+submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or
+imagery, derogatory comments or personal attacks, trolling, public or private harassment,
+insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this 
+Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
+from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
+opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant 
+(http://contributor-covenant.org), version 1.0.0, available at 
+http://contributor-covenant.org/version/1/0/0/

.github/CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# Contributing
+
+Contributions to `netrics`, 
+whether in the form of issue identification, bug fixes, new code or documentation 
+are encouraged and welcome.
+
+## Aims
+
+Here is some things that Guy Kawasaki, Silicon Valley venture capitalist,
+learned from Steve Jobs:
+
+- "Experts" are clueless. Especially self-declared ones.
+- Customers cannot tell you what they need. They can help with evolution, but not revolution.
+- Biggest challenges beget the best work.
+- Design counts. Users will see the skin/UI of your product, not the great algorithms.
+- Big graphics, big fonts.
+- Jump curves---do things 10 times better, not 10 percent.
+- All that truly matters is whether something works or doesn't work. Open or close, iPhone or Android, car or train, doesn't matter---make
+it work.
+- "Value" is different from "price". There is a class of people who do care about value. Ease of use -> less support costs. You have to create a unique and valuable product as an engineer.
+- Real CEOs can demo. If you can't demo your own product, then quit.
+- Real entrepreneurs ship, not slip.
+- Some things need to be believed to be seen.
+
+## Git
+
+`stocnet` projects are maintained using the git version control system.
+A plain-English introduction to git can be found [here](https://blog.red-badger.com/2016/11/29/gitgithub-in-plain-english).
+I recommend you read this before continuing. 
+A more recent motivation can be found [here](https://www.r-bloggers.com/2024/04/git-gud-version-control-best-practices/).
+It will explain the basics of git version control, committing and repos, pulling and pushing,
+branching and merging.
+
+Using git from the command line on your lap- or desktop can be intimidating,
+but I recommend [Fork](https://git-fork.com) software for Mac and Windows.
+This allows mostly visual management of commits, diffs, branches, etc.
+There are various other git software packages available, but this one is fairly fully featured.
+
+The GitHub page allows to access the issues assigned to you and check the commits.
+You can also access the documents in the repository, 
+although this won't be necessary after you have cloned it on your computer via Fork.
+
+## Style
+
+In terms of style, we are aiming for pleasant predictability in terms of user experience.
+To that end, we have a regular syntax that users can rely on producing expected effects.
+
+## Fork
+
+### Cloning
+Once you have downloaded Fork, the first thing you have to do is to 
+clone the remote repository on your computer. 
+Before cloning, you will be able to choose on which `branch` you want to work: 
+develop or main. 
+
+### Pull 
+This command allows you to `pull` changes from the remote repository to your local repository on Sourcetree.
+Make sure you do that before starting working on your files so you have the newest versions. 
+When pulling, make sure you choose master or develop, 
+depending on the branch you decided to work with. 
+Once you pulled, you have now all the new commits and files and 
+you can start working on your assigned tasks.
+Note that you can access and open the files either from the Finder or from Fork. 
+Some documents might be stored using Large File Storage (LFS) to save space on the repository. 
+
+### Commit and Push
+
+Once you have made modifications on a file and saved them, it will appear in your `commit` window. 
+Here you can control one last time your file, write the commit message with the 
+issue reference (see below) and commit. 
+Once your commit is ready, you can `push` them to the origin/main repository.
+Note that you can click the "push immediately" box in the commit window 
+if you don't want to do it in two steps. 
+If you are working on a separate branch, 
+it is important to select this branch when pushing to origin/main.
+
+## Issues and tests
+
+Please use the issues tracker on GitHub to identify any function-related issues.
+You can use these issues to track progress on the issue and 
+to comment or continue a conversation on that issue.
+Currently issue tracking is only open to those involved in the project.
+
+The most useful issues are ones that precisely identify an error,
+or propose a test that should pass but instead fails.
+This package uses the `testthat` package for testing functions.
+Please see the [testthat website](https://testthat.r-lib.org) for more details.
+
+## Bug fixing or adding new code
+
+Independent or assigned code contributions are most welcome.
+When writing new code, please follow 
+[standard R guidelines](https://www.r-bloggers.com/🖊-r-coding-style-guide/). 
+It can help to use packages such as `lintr`, `goodpractice` and `formatR` 
+to ensure these are followed.
+
+Currently, commits can only be pushed to GitHub where they reference an existing issue.
+If no issue exists for the code you have developed, please add an issue first before pushing.
+Once the issue exists, you will need to mention the issue number (preceded by a hash symbol: #)
+in the commit description:
+
+` Resolved #31 by adding a new function that does things, also updated documentation `
+
+Where the issue hash (i.e. #31) is preceded by
+`resolve`, `resolves`, `resolved`, `close`, `closes`, `closed`, `fix`, `fixes`, or `fixed`
+(capitalised or not),
+Github will automatically updated the status of the issue(s) mentioned.
+
+Our current syntactical standard is to mention the issue first and then 
+provide a short description of what the committed changes do 
+in relation to that issue.
+Any ancillary changes can be mentioned after a comma.
+
+## Documentation
+
+A final way of contributing to the package is in developing the 
+vignettes/articles that illustrate the value added in the package. 
+Please contact me with any proposals here.
+
+Please note that the `netrics` project is released with a 
+[Contributor Code of Conduct](CODE_OF_CONDUCT.md). 
+By contributing to this project, you agree to abide by its terms.
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Provide system information**
+ - OS: [e.g. MacOS Mojave 10.14.6]
+ - R version: [e.g. 3.5.3]
+ - netrics version: [e.g. 1.4.0]
+
+**To Reproduce**
+Please consider providing a [reprex](https://reprex.tidyverse.org) (a reproducible example),
+or outline the steps taken to reproduce the behaviour, e.g.:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+If applicable, add screenshots to help explain your problem.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation_request.md

@@ -0,0 +1,12 @@
+---
+name: Documentation request
+about: Create a report to help us improve
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Name the function or functions that require further documentation here and in the title**
+
+Please describe what is not clear in the current documentation that can be expanded upon.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature_request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/test_request.md

@@ -0,0 +1,10 @@
+---
+name: Test request
+about: Create a report to help us improve
+title: ''
+labels: tests
+assignees: ''
+
+---
+
+**Name the function or functions that require the tests here and in the title**

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+# Description
+
+# Checklist:
+
+- Documentation
+  - [ ] DESCRIPTION file version is bumped by the appropriate increment (major, minor, patch)
+  - [ ] Date in DESCRIPTION is correct
+  - [ ] Longer functions are commented inline or broken down into helper functions to help debugging
+- PR form
+  - [ ] Title indicates expected version number
+  - [ ] PR description above and the NEWS.md file are aligned
+  - [ ] Description above itemizes changes under subsection titles, e.g. "## Data"
+  - [ ] Closed, fixed, or related issues are referenced and explained in the description above, e.g. "Fixed #0 by adding A"

.github/workflows/prchecks.yml

@@ -0,0 +1,74 @@
+on:
+  pull_request:
+    branches:
+      - main
+
+name: Binary checks
+
+jobs:
+
+  build:
+    name: Build for ${{ matrix.config.os }}
+    runs-on: ${{ matrix.config.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macOS-latest,   r: 'release', artifact_name: '*.tar.gz', asset_name: macOS}
+          - {os: windows-latest, r: 'release', artifact_name: '*.zip', asset_name: winOS}
+          - {os: ubuntu-latest, r: 'release', artifact_name: '*.tar.gz', asset_name: linuxOS}
+
+    env:
+      R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
+      RSPM: ${{ matrix.config.rspm }}
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          cache-version: 2
+          needs: check, build
+          extra-packages: |
+            any::rcmdcheck
+
+      - uses: r-lib/actions/check-r-package@v2
+        env:
+          _R_CHECK_FORCE_SUGGESTS_: false
+        with:
+          upload-snapshots: true
+
+      - name: Binary
+        run: |
+          pkgbuild::clean_dll()
+          binary <- pkgbuild::build(binary = TRUE, needs_compilation = TRUE, compile_attributes = TRUE)
+          dir.create("build")
+          file.copy(binary, "build")
+        shell: Rscript {0}
+
+      - name: Save binary artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.config.asset_name }}
+          path: build/
+
+      - name: Calculate code coverage
+        if: runner.os == 'macOS'
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: Rscript -e 'covr::codecov(token = Sys.getenv("CODECOV_TOKEN"))'
+
+      - name: Lint
+        run: lintr::lint_package()
+        shell: Rscript {0}
+
+      - name: Spell check
+        run: spelling::spell_check_package()
+        shell: Rscript {0}