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

New examples #229

Merged
merged 29 commits into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
eb6b63b
Comments out Cost of reoffending example
danmilne1 Oct 4, 2023
1936bc5
Creates a minimal penguins example
danmilne1 Oct 4, 2023
27ff895
Creates an example showing how to write a workbook with a cover
danmilne1 Oct 4, 2023
deb4a6c
Creates an example showing how to do notes in gptables
danmilne1 Oct 4, 2023
3da569e
Creates an example demonstrating the use of the additional_formatting…
danmilne1 Oct 4, 2023
0614b17
Removes old iris examples
danmilne1 Oct 4, 2023
f0ed2f1
Changes docs to display new examples
danmilne1 Oct 4, 2023
5959027
Fixes example headers
danmilne1 Oct 4, 2023
e1c2442
Relaces iris theme example with penguins theme example
danmilne1 Oct 4, 2023
25a3016
Fixes theme example header
danmilne1 Oct 4, 2023
e3ddf08
Renames iris theme to penguins
danmilne1 Oct 4, 2023
6168853
Fixes typos in minimal example
danmilne1 Oct 16, 2023
45af7c0
Fixes typos in cover example
danmilne1 Oct 16, 2023
546ccfd
Rewrites header for notes example
danmilne1 Oct 16, 2023
8f7b2c6
Tidies up the theme example
danmilne1 Oct 16, 2023
0e315af
Fixes typos in additional_formatting example
danmilne1 Oct 16, 2023
b018a70
Fixes display lines for examples
danmilne1 Oct 16, 2023
959ca26
Adds index_columns to cover example
danmilne1 Oct 16, 2023
634c7f7
Provides source for penguins dataset
danmilne1 Jun 28, 2024
4139b13
Removes old examples
danmilne1 Jun 28, 2024
0b3c087
Removes multiple sheets example from cover example
danmilne1 Jun 28, 2024
4b84afe
Adds separate multiple sheets example
danmilne1 Jun 28, 2024
d1c1da6
Removes additional things from minimal example
danmilne1 Jun 28, 2024
1fea012
Replaces penguins theme with default theme
danmilne1 Jun 28, 2024
f0f06a5
Removes R example
danmilne1 Jun 28, 2024
04a9528
Adds new examples
danmilne1 Jun 28, 2024
ab680ea
Minor changes to multiple sheets example
danmilne1 Jul 2, 2024
d3fb932
Re-adds specific example theme
danmilne1 Jul 2, 2024
27ca98b
Fixes merge conflicts
danmilne1 Jul 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 28 additions & 20 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,45 +13,53 @@ examples_ directory of the package.
.. todo:: Replace datasets in examples with open online datasets


.. automodule:: gptables.examples.iris
.. automodule:: gptables.examples.penguins_minimal

.. literalinclude:: ../../gptables/examples/iris.py
.. literalinclude:: ../../gptables/examples/penguins_minimal.py
:language: python
:lines: 15-
:lines: 16-

.. automodule:: gptables.examples.penguins_minimal_alternate

.. automodule:: gptables.examples.iris_cover
.. literalinclude:: ../../gptables/examples/penguins_minimal_alternate.py
:language: python
:lines: 16-

.. literalinclude:: ../../gptables/examples/iris_cover.py
.. literalinclude:: ../../gptables/examples/penguins_multiple_sheets.py
:language: python
:lines: 12-
:lines: 16-

.. automodule:: gptables.examples.penguins_theme

.. literalinclude:: ../../gptables/examples/penguins_theme.py
:language: python
:lines: 16-

.. automodule:: gptables.examples.iris_additional_formatting
.. automodule:: gptables.examples.penguins_cover

.. literalinclude:: ../../gptables/examples/iris_additional_formatting.py
.. literalinclude:: ../../gptables/examples/penguins_cover.py
:language: python
:lines: 24-
:lines: 14-

.. automodule:: gptables.examples.penguins_notes

.. automodule:: gptables.examples.cor_multiple_sheets
.. literalinclude:: ../../gptables/examples/penguins_notes.py
:language: python
:lines: 15-

.. literalinclude:: ../../gptables/examples/cor_multiple_sheets.py
.. automodule:: gptables.examples.penguins_additional_formatting

.. literalinclude:: ../../gptables/examples/penguins_additional_formatting.py
:language: python
:lines: 16-
:lines: 25-




R Usage
-------

Use of ``gptables`` in R requires use of python via the `reticulate <https://rstudio.github.io/reticulate/>`_ package.

This example demonstrates basic usage of the pacakge in R. More advanced usage will
use a similar approach to python (above), but may require use of ``reticulate`` functions
to create/modify python objects.

.. literalinclude:: ../../gptables/examples/iris.R
:language: R

R users may also be interested in the `a11ytables <https://co-analysis.github.io/a11ytables/>`_
However we recommend use of the `a11ytables <https://co-analysis.github.io/a11ytables/>`_
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good recommendation

R package, developed by the Cabinet Office.
20 changes: 0 additions & 20 deletions gptables/examples/R_install_dependency_file.R

This file was deleted.

74 changes: 0 additions & 74 deletions gptables/examples/cor_multiple_sheets.py

This file was deleted.

Loading
Loading