Commit files for initial upload (#1)

* commit files for initial upload

* Update python_package/Pipfile

* Update python_package/Pipfile

* update Pipfile.lock

---------

Co-authored-by: Alex Sadleir <[email protected]>

.gitignore

@@ -0,0 +1,109 @@
+# Backup files
+*.DS_Store
+.envrc
+
+# Editors
+.idea
+.vscode/
+.editorconfig
+*.code-workspace
+
+# Images
+*.png
+
+# Compiled pystan models
+model-*.p
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+ve/
+
+
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# R packaging
+.Rproj.user
+.Rhistory
+
+# Java
+.classpath
+.project
+.settings/
+
+# Julia
+Manifest.toml
+
+/python_package/node_modules/
+
+.env
+
+Pipfile.lock

README.md

@@ -1,2 +1,58 @@
-# flourishcharts
-Interactive data visualization Python and R packages for data scientists.
+## `flourishcharts`: Flourish in R & Python
+
+|   |   |   |
+| ------------- | ------------- | ------------- |
+[![Scatterplot](utils/img/scatter.png)]() | [![Bar chart race](utils/img/rbc.png)]()  |   [![Sankey diagram](utils/img/alluvial.png)]() |
+|  | |
+
+Interactive data visualization for data practitioners. `flourishcharts` allows users to visualize their data 
+using Flourish charts that are grounded in data storytelling principles. Users can create racing bar & line
+charts, as well as other interactive elements commonly found in d3.js graphics, easily in R and Python. 
+The package relies on an enterprise API provided by Flourish.
+
+### Python package installation
+
+You can install to a specific virtual env by using `pipenv`:
+
+```
+pipenv install flourishcharts
+```
+
+or to your global Python installation with `pip`:
+
+```
+python3 -m pip install --upgrade flourishcharts
+```
+
+### R package installation
+Install from CRAN via:
+
+```
+install.packages("flourishcharts")
+```
+
+Alternatively, install from GitHub:
+
+```
+remotes::install_git("canva-public/flourishcharts", subdir="R_package")
+```
+
+### Key info
+
+Grab a Flourish API key from [https://app.flourish.studio/settings](https://app.flourish.studio/settings). Store in one of two places, depending on language used:
+
+* Python: in the `~/.envrc` file for the Python environment or, alternatively, your `~/.zshrc` or `~/.bashrc` file.
+
+```
+export FLOURISH_API_KEY="..."
+```
+
+* R: In your `~/.Renviron` file:
+
+```
+FLOURISH_API_KEY = "..."
+```
+
+### Any issues?
+
+Please log an issue in the GitHub repository.

R_package/DESCRIPTION

@@ -0,0 +1,45 @@
+Package: flourishcharts
+Title: Flourish for R and Python
+Version: 1.0.0.0
+Authors@R: c(
+    person(given = "Zoe",
+           family = "Meers",
+           role = c("aut", "cre", "trl", "cph"),
+           email = "[email protected]"),
+    person(given = "Alex",
+           family = "Sadleir",
+           role = c("aut"),
+           email = "[email protected]"),
+    person(given = "Luisa",
+           family = "Bider",
+           role = c("aut"),
+           email = "[email protected]")
+    )
+Description: Interactive data visualization for data practitioners. 'flourishcharts' allows users to visualize their data 
+  using Flourish charts that are grounded in data storytelling principles. Users can create racing bar & line
+  charts, as well as other interactive elements commonly found in d3 graphics, easily in R and Python. 
+  The package relies on an enterprise API provided by Flourish.
+License: MIT + file LICENSE
+Encoding: UTF-8
+Language: en
+LazyData: true
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.2
+Suggests: 
+    testthat (>= 3.2.0),
+    knitr,
+    rmarkdown,
+    reticulate,
+    tidyr,
+    here
+Config/testthat/edition: 3
+Depends: 
+    R (>= 4.00)
+Imports:
+    htmlwidgets,
+    htmltools,
+    jsonlite,
+    dplyr,
+    httr,
+    utils
+VignetteBuilder: knitr

R_package/LICENSE

@@ -0,0 +1,2 @@
+YEAR: 2024
+COPYRIGHT HOLDER: flourishcharts authors

R_package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 flourishcharts authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

R_package/NAMESPACE

@@ -0,0 +1,70 @@
+# Generated by roxygen2: do not edit by hand
+
+export(bind_audio_data)
+export(bind_bar_chart_race_data)
+export(bind_bubble_chart_data)
+export(bind_calculator_data)
+export(bind_cards_data)
+export(bind_chord_diagram_data)
+export(bind_draw_the_line_data)
+export(bind_election_results_chart_data)
+export(bind_gantt_data)
+export(bind_gauge_data)
+export(bind_hierarchy_data)
+export(bind_horserace_data)
+export(bind_interactive_svg_data)
+export(bind_line_bar_pie_data)
+export(bind_marimekko_data)
+export(bind_network_graph_data)
+export(bind_parliament_chart_data)
+export(bind_pictogram_data)
+export(bind_quiz_data)
+export(bind_radar_data)
+export(bind_sankey_data)
+export(bind_scatter_data)
+export(bind_slope_chart_data)
+export(bind_sports_data)
+export(bind_sports_race_data)
+export(bind_survey_data)
+export(bind_svg_annotator_data)
+export(bind_table_data)
+export(bind_text_annotator_data)
+export(bind_timeline_data)
+export(bind_tournament_data)
+export(bind_word_cloud_data)
+export(flourish)
+export(set_audio_details)
+export(set_bar_chart_race_details)
+export(set_bubble_chart_details)
+export(set_calculator_details)
+export(set_cards_details)
+export(set_chord_diagram_details)
+export(set_countdown_details)
+export(set_draw_the_line_details)
+export(set_election_results_chart_details)
+export(set_gantt_details)
+export(set_gauge_details)
+export(set_hierarchy_details)
+export(set_horserace_details)
+export(set_interactive_svg_details)
+export(set_line_bar_pie_details)
+export(set_marimekko_details)
+export(set_network_graph_details)
+export(set_number_ticker_details)
+export(set_parliament_chart_details)
+export(set_photo_slider_details)
+export(set_pictogram_details)
+export(set_quiz_details)
+export(set_radar_details)
+export(set_sankey_details)
+export(set_scatter_details)
+export(set_slope_chart_details)
+export(set_sports_details)
+export(set_sports_race_details)
+export(set_survey_details)
+export(set_svg_annotator_details)
+export(set_table_details)
+export(set_text_annotator_details)
+export(set_timeline_details)
+export(set_tournament_details)
+export(set_word_cloud_details)