Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Commit

Permalink
build based on 4e5d505
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 23, 2024
1 parent ae07ebf commit e959515
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-23T18:12:00","documenter_version":"1.1.0"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-23T18:12:59","documenter_version":"1.1.0"}}
4 changes: 2 additions & 2 deletions dev/advising/index.html
View file

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions dev/errors/index.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/libinternal/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/newtransformer/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Transformer backends · DataToolkitBase.jl</title><meta name="title" content="Transformer backends · DataToolkitBase.jl"/><meta property="og:title" content="Transformer backends · DataToolkitBase.jl"/><meta property="twitter:title" content="Transformer backends · DataToolkitBase.jl"/><meta name="description" content="Documentation for DataToolkitBase.jl."/><meta property="og:description" content="Documentation for DataToolkitBase.jl."/><meta property="twitter:description" content="Documentation for DataToolkitBase.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="DataToolkitBase.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">DataToolkitBase.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Introduction</a></li><li><a class="tocitem" href="../usage/">Usage</a></li><li><a class="tocitem" href="../datatoml/">Data.toml</a></li><li><a class="tocitem" href="../repl/">REPL</a></li><li><span class="tocitem">Extensions</span><ul><li class="is-active"><a class="tocitem" href>Transformer backends</a></li><li><a class="tocitem" href="../packages/">Packages</a></li><li><a class="tocitem" href="../advising/">Data Advice</a></li></ul></li><li><a class="tocitem" href="../libinternal/">Internals</a></li><li><a class="tocitem" href="../errors/">Errors</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Extensions</a></li><li class="is-active"><a href>Transformer backends</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Transformer backends</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/tecosaur/DataToolkitBase.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/main/docs/src/newtransformer.org" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Creating-a-new-data-transformer"><a class="docs-heading-anchor" href="#Creating-a-new-data-transformer">Creating a new data transformer</a><a id="Creating-a-new-data-transformer-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-a-new-data-transformer" title="Permalink"></a></h1><p>As mentioned before, there are three types of data transformer:</p><ul><li><code>storage</code></li><li><code>loader</code></li><li><code>writer</code></li></ul><p>The three corresponding Julia types are:</p><ul><li><code>DataStorage</code></li><li><code>DataLoader</code></li><li><code>DataWriter</code></li></ul><p>All three types accept a <code>driver</code> (symbol) type parameter. For example, a storage transformer using a &quot;filesystem&quot; driver would be of the type <code>DataStorage{:filesystem}</code>.</p><p>Adding support for a new driver is a simple as adding method implementations for the three key data transformer methods:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DataToolkitBase.load" href="#DataToolkitBase.load"><code>DataToolkitBase.load</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">load(loader::DataLoader{driver}, source::Any, as::Type)</code></pre><p>Using a certain <code>loader</code>, obtain information in the form of <code>as</code> from the data given by <code>source</code>.</p><p>This fulfils this component of the overall data flow:</p><pre><code class="nohighlight hljs"> ╭────loader─────╮
╵ ▼
Data Information</code></pre><p>When the loader produces <code>nothing</code> this is taken to indicate that it was unable to load the data for some reason, and that another loader should be tried if possible. This can be considered a soft failure. Any other value is considered valid information.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/c3da8e590d9bc55f960108749ad8c8bb9979d433/src/interaction/externals.jl#L300-L317">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DataToolkitBase.storage" href="#DataToolkitBase.storage"><code>DataToolkitBase.storage</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">storage(storer::DataStorage, as::Type; write::Bool=false)</code></pre><p>Fetch a <code>storer</code> in form <code>as</code>, appropiate for reading from or writing to (depending on <code>write</code>).</p><p>By default, this just calls <code>getstorage</code> or <code>putstorage</code> (when <code>write=true</code>).</p><p>This executes this component of the overall data flow:</p><pre><code class="nohighlight hljs">Storage ◀────▶ Data</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/c3da8e590d9bc55f960108749ad8c8bb9979d433/src/interaction/externals.jl#L352-L364">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DataToolkitBase.save" href="#DataToolkitBase.save"><code>DataToolkitBase.save</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">save(writer::Datasaveer{driver}, destination::Any, information::Any)</code></pre><p>Using a certain <code>writer</code>, save the <code>information</code> to the <code>destination</code>.</p><p>This fulfils this component of the overall data flow:</p><pre><code class="nohighlight hljs">Data Information
Data Information</code></pre><p>When the loader produces <code>nothing</code> this is taken to indicate that it was unable to load the data for some reason, and that another loader should be tried if possible. This can be considered a soft failure. Any other value is considered valid information.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/4e5d5051b511e539f326f72f101b86b8b881eb54/src/interaction/externals.jl#L229-L246">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DataToolkitBase.storage" href="#DataToolkitBase.storage"><code>DataToolkitBase.storage</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">storage(storer::DataStorage, as::Type; write::Bool=false)</code></pre><p>Fetch a <code>storer</code> in form <code>as</code>, appropiate for reading from or writing to (depending on <code>write</code>).</p><p>By default, this just calls <code>getstorage</code> or <code>putstorage</code> (when <code>write=true</code>).</p><p>This executes this component of the overall data flow:</p><pre><code class="nohighlight hljs">Storage ◀────▶ Data</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/4e5d5051b511e539f326f72f101b86b8b881eb54/src/interaction/externals.jl#L283-L295">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DataToolkitBase.save" href="#DataToolkitBase.save"><code>DataToolkitBase.save</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">save(writer::Datasaveer{driver}, destination::Any, information::Any)</code></pre><p>Using a certain <code>writer</code>, save the <code>information</code> to the <code>destination</code>.</p><p>This fulfils this component of the overall data flow:</p><pre><code class="nohighlight hljs">Data Information
▲ ╷
╰────writer─────╯</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/c3da8e590d9bc55f960108749ad8c8bb9979d433/src/interaction/externals.jl#L424-L435">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../repl/">« REPL</a><a class="docs-footer-nextpage" href="../packages/">Packages »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Thursday 23 May 2024 18:12">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
╰────writer─────╯</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/tecosaur/DataToolkitBase.jl/blob/4e5d5051b511e539f326f72f101b86b8b881eb54/src/interaction/externals.jl#L355-L366">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../repl/">« REPL</a><a class="docs-footer-nextpage" href="../packages/">Packages »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Thursday 23 May 2024 18:12">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit e959515

Please sign in to comment.