Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Package documentation #8

Closed
4 of 5 tasks
Aariq opened this issue Sep 19, 2019 · 4 comments
Closed
4 of 5 tasks

Package documentation #8

Aariq opened this issue Sep 19, 2019 · 4 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Aariq
Copy link
Owner

Aariq commented Sep 19, 2019

Check that package documentation is complete. I think I still need:

  • [ ] Double check docs for bipm()
  • Double check docs for bombus()
  • Double check docs for bumbl()
  • Package description
  • Elizabeth's ORCID (if she has one and wants it to be associated with the package)
  • Citation (should it be Crone and Williams? Maybe not if bumbl also includes Natalie's work)
@Aariq Aariq added the documentation Improvements or additions to documentation label Sep 19, 2019
@Aariq
Copy link
Owner Author

Aariq commented Feb 28, 2020

Citation should include both papers and description on citing package in addition to one or both papers depending on which functions used.

@Aariq
Copy link
Owner Author

Aariq commented Nov 30, 2020

For now, I'm only going to submit the switchpoint functions to CRAN. The IPM will be in a future version, once I can get feedback from IPM authors.

@Aariq
Copy link
Owner Author

Aariq commented Dec 8, 2020

In addition to Crone and Williams, users should cite the package itself with Eric and Elizabeth as co-authors. Archive with Zenodo to get DOI to associate with package.

@Aariq
Copy link
Owner Author

Aariq commented Feb 17, 2021

Moving citation to separate issue since needs to happen after a release

@Aariq Aariq closed this as completed Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant