Cleanup before CRAN release #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@ilyabo sorry about the links to my other package, I will regenerate the metadata. It go in there while i was copying over some code for reuse. |
Co-authored-by: Ilya Boyandin <ilyabo@gmail.com>
Co-authored-by: Ilya Boyandin <ilyabo@gmail.com>
Co-authored-by: Ilya Boyandin <ilyabo@gmail.com>
|
Closes #2 . |
|
No worries. I will need to change the FlowmapBlue project config (namely convert it to a monorepo and publish a library, right now it's a nextjs app). Will try to find time for it. |
great! Final thing to do is to add https://flowmapblue.github.io/flowmapblue.R/ (or just enable automatic URL to gh-pages) in the front page repo settings. Like so:
I will also add this gh-pages link to package readme and metadata and submit to CRAN. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@ilyabo hi! I made some changes to the package:
implemented and documented processing of the
timecolumn, so that users only need to create it in datetime or date type in R and it is automatically converted to UNIX time and used in the widgetdocumented the
flowmapbluefunction with examplescreated vignette based on the examples from above with gifs for website and static pngs for the CRAN vignette
created a pkgdown website for the package that can be auto-published using GitHub action (action pushed to branch too) assuming you are willing to host the website using GitHub pages at https://flowmapblue.github.io/flowmapblue.R (needs to be turned on in https://github.com/FlowmapBlue/flowmapblue.R/settings/pages and set to deploy from branch and set to
gh-pagesbranch, which I already created with the pre-rendered website).added opengraph card (that shows up when the link is shared on social media). It will show up for https://flowmapblue.github.io/flowmapblue.R automatically, for GitHub repo link https://github.com/FlowmapBlue/flowmapblue.R/, you need to manually upload it from here https://github.com/FlowmapBlue/flowmapblue.R/blob/prep-for-CRAN-release/man/figures/opengraph-card.png into the
Social previewsection in repo settings https://github.com/FlowmapBlue/flowmapblue.R/settingsadded GitHub action for CI/CD to autocheck any future commits/PRs with R CMD Check
cleaned up description and added metadata, as well as CRAN comments for submission
properly bundled the example data as
ch_locationsandch_flows, they are now available as exported objects in the package. Note: would be great to reference the source of this data for completeness of the documentation.