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

How to create a new type of board #481

Open
hadley opened this issue Aug 17, 2021 · 3 comments
Open

How to create a new type of board #481

hadley opened this issue Aug 17, 2021 · 3 comments

Comments

@hadley
Copy link
Member

hadley commented Aug 17, 2021

Start by implementing each of the following functions in order to get the basic functions of a board working:

  • Constructor
  • pin_list() and/or pin_search() depending on how many pins you expect
  • pin_exists()
  • pin_meta()
  • pin_fetch()
  • pin_versions()
  • pin_store()

Next get all of the cross-board tests working:

  • test_api_basic()
  • test_api_versioning()
  • test_api_meta()

Check test coverage, and make sure you have extra tests for any specific behaviour that this board should possess.

@hadley hadley changed the title How to create a board How to create a new type of board Aug 31, 2021
@juliasilge
Copy link
Member

What if we documented this as a README inside of R/, instead of a user-facing vignette? parsnip has one of these, and it seems like a good, low-lift option for this kind of developer-facing info.

@hadley
Copy link
Member Author

hadley commented Nov 7, 2022

I don't love it, just because I personally would have no idea to look there.

@juliasilge
Copy link
Member

Thanks to @edgararuiz for pointing out that you also need to create:

  • pin_delete()
  • pin_version_delete() for boards with prefixes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants