+
+
+
-
+
+
-
-
-
+
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
index d392500..a2833ec 100644
--- a/docs/LICENSE.html
+++ b/docs/LICENSE.html
@@ -1,71 +1,12 @@
-
-
-
-
-
-
-
-MIT License • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-MIT License • tidyft
+
-
-
-
-
License
@@ -133,26 +59,28 @@License
-
-
-
-
-
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/articles/Introduction.html b/docs/articles/Introduction.html
index dbf2302..62b38d1 100644
--- a/docs/articles/Introduction.html
+++ b/docs/articles/Introduction.html
@@ -12,400 +12,444 @@
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-
MIT License
@@ -137,26 +63,28 @@MIT License
-
-
-
-
-
+
+
+
+
+
+
diff --git a/docs/articles/Introduction_files/htmlwidgets-1.6.1/htmlwidgets.js b/docs/articles/Introduction_files/htmlwidgets-1.6.1/htmlwidgets.js
new file mode 100644
index 0000000..1067d02
--- /dev/null
+++ b/docs/articles/Introduction_files/htmlwidgets-1.6.1/htmlwidgets.js
@@ -0,0 +1,901 @@
+(function() {
+ // If window.HTMLWidgets is already defined, then use it; otherwise create a
+ // new object. This allows preceding code to set options that affect the
+ // initialization process (though none currently exist).
+ window.HTMLWidgets = window.HTMLWidgets || {};
+
+ // See if we're running in a viewer pane. If not, we're in a web browser.
+ var viewerMode = window.HTMLWidgets.viewerMode =
+ /\bviewer_pane=1\b/.test(window.location);
+
+ // See if we're running in Shiny mode. If not, it's a static document.
+ // Note that static widgets can appear in both Shiny and static modes, but
+ // obviously, Shiny widgets can only appear in Shiny apps/documents.
+ var shinyMode = window.HTMLWidgets.shinyMode =
+ typeof(window.Shiny) !== "undefined" && !!window.Shiny.outputBindings;
+
+ // We can't count on jQuery being available, so we implement our own
+ // version if necessary.
+ function querySelectorAll(scope, selector) {
+ if (typeof(jQuery) !== "undefined" && scope instanceof jQuery) {
+ return scope.find(selector);
+ }
+ if (scope.querySelectorAll) {
+ return scope.querySelectorAll(selector);
+ }
+ }
+
+ function asArray(value) {
+ if (value === null)
+ return [];
+ if ($.isArray(value))
+ return value;
+ return [value];
+ }
+
+ // Implement jQuery's extend
+ function extend(target /*, ... */) {
+ if (arguments.length == 1) {
+ return target;
+ }
+ for (var i = 1; i < arguments.length; i++) {
+ var source = arguments[i];
+ for (var prop in source) {
+ if (source.hasOwnProperty(prop)) {
+ target[prop] = source[prop];
+ }
+ }
+ }
+ return target;
+ }
+
+ // IE8 doesn't support Array.forEach.
+ function forEach(values, callback, thisArg) {
+ if (values.forEach) {
+ values.forEach(callback, thisArg);
+ } else {
+ for (var i = 0; i < values.length; i++) {
+ callback.call(thisArg, values[i], i, values);
+ }
+ }
+ }
+
+ // Replaces the specified method with the return value of funcSource.
+ //
+ // Note that funcSource should not BE the new method, it should be a function
+ // that RETURNS the new method. funcSource receives a single argument that is
+ // the overridden method, it can be called from the new method. The overridden
+ // method can be called like a regular function, it has the target permanently
+ // bound to it so "this" will work correctly.
+ function overrideMethod(target, methodName, funcSource) {
+ var superFunc = target[methodName] || function() {};
+ var superFuncBound = function() {
+ return superFunc.apply(target, arguments);
+ };
+ target[methodName] = funcSource(superFuncBound);
+ }
+
+ // Add a method to delegator that, when invoked, calls
+ // delegatee.methodName. If there is no such method on
+ // the delegatee, but there was one on delegator before
+ // delegateMethod was called, then the original version
+ // is invoked instead.
+ // For example:
+ //
+ // var a = {
+ // method1: function() { console.log('a1'); }
+ // method2: function() { console.log('a2'); }
+ // };
+ // var b = {
+ // method1: function() { console.log('b1'); }
+ // };
+ // delegateMethod(a, b, "method1");
+ // delegateMethod(a, b, "method2");
+ // a.method1();
+ // a.method2();
+ //
+ // The output would be "b1", "a2".
+ function delegateMethod(delegator, delegatee, methodName) {
+ var inherited = delegator[methodName];
+ delegator[methodName] = function() {
+ var target = delegatee;
+ var method = delegatee[methodName];
+
+ // The method doesn't exist on the delegatee. Instead,
+ // call the method on the delegator, if it exists.
+ if (!method) {
+ target = delegator;
+ method = inherited;
+ }
+
+ if (method) {
+ return method.apply(target, arguments);
+ }
+ };
+ }
+
+ // Implement a vague facsimilie of jQuery's data method
+ function elementData(el, name, value) {
+ if (arguments.length == 2) {
+ return el["htmlwidget_data_" + name];
+ } else if (arguments.length == 3) {
+ el["htmlwidget_data_" + name] = value;
+ return el;
+ } else {
+ throw new Error("Wrong number of arguments for elementData: " +
+ arguments.length);
+ }
+ }
+
+ // http://stackoverflow.com/questions/3446170/escape-string-for-use-in-javascript-regex
+ function escapeRegExp(str) {
+ return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
+ }
+
+ function hasClass(el, className) {
+ var re = new RegExp("\\b" + escapeRegExp(className) + "\\b");
+ return re.test(el.className);
+ }
+
+ // elements - array (or array-like object) of HTML elements
+ // className - class name to test for
+ // include - if true, only return elements with given className;
+ // if false, only return elements *without* given className
+ function filterByClass(elements, className, include) {
+ var results = [];
+ for (var i = 0; i < elements.length; i++) {
+ if (hasClass(elements[i], className) == include)
+ results.push(elements[i]);
+ }
+ return results;
+ }
+
+ function on(obj, eventName, func) {
+ if (obj.addEventListener) {
+ obj.addEventListener(eventName, func, false);
+ } else if (obj.attachEvent) {
+ obj.attachEvent(eventName, func);
+ }
+ }
+
+ function off(obj, eventName, func) {
+ if (obj.removeEventListener)
+ obj.removeEventListener(eventName, func, false);
+ else if (obj.detachEvent) {
+ obj.detachEvent(eventName, func);
+ }
+ }
+
+ // Translate array of values to top/right/bottom/left, as usual with
+ // the "padding" CSS property
+ // https://developer.mozilla.org/en-US/docs/Web/CSS/padding
+ function unpackPadding(value) {
+ if (typeof(value) === "number")
+ value = [value];
+ if (value.length === 1) {
+ return {top: value[0], right: value[0], bottom: value[0], left: value[0]};
+ }
+ if (value.length === 2) {
+ return {top: value[0], right: value[1], bottom: value[0], left: value[1]};
+ }
+ if (value.length === 3) {
+ return {top: value[0], right: value[1], bottom: value[2], left: value[1]};
+ }
+ if (value.length === 4) {
+ return {top: value[0], right: value[1], bottom: value[2], left: value[3]};
+ }
+ }
+
+ // Convert an unpacked padding object to a CSS value
+ function paddingToCss(paddingObj) {
+ return paddingObj.top + "px " + paddingObj.right + "px " + paddingObj.bottom + "px " + paddingObj.left + "px";
+ }
+
+ // Makes a number suitable for CSS
+ function px(x) {
+ if (typeof(x) === "number")
+ return x + "px";
+ else
+ return x;
+ }
+
+ // Retrieves runtime widget sizing information for an element.
+ // The return value is either null, or an object with fill, padding,
+ // defaultWidth, defaultHeight fields.
+ function sizingPolicy(el) {
+ var sizingEl = document.querySelector("script[data-for='" + el.id + "'][type='application/htmlwidget-sizing']");
+ if (!sizingEl)
+ return null;
+ var sp = JSON.parse(sizingEl.textContent || sizingEl.text || "{}");
+ if (viewerMode) {
+ return sp.viewer;
+ } else {
+ return sp.browser;
+ }
+ }
+
+ // @param tasks Array of strings (or falsy value, in which case no-op).
+ // Each element must be a valid JavaScript expression that yields a
+ // function. Or, can be an array of objects with "code" and "data"
+ // properties; in this case, the "code" property should be a string
+ // of JS that's an expr that yields a function, and "data" should be
+ // an object that will be added as an additional argument when that
+ // function is called.
+ // @param target The object that will be "this" for each function
+ // execution.
+ // @param args Array of arguments to be passed to the functions. (The
+ // same arguments will be passed to all functions.)
+ function evalAndRun(tasks, target, args) {
+ if (tasks) {
+ forEach(tasks, function(task) {
+ var theseArgs = args;
+ if (typeof(task) === "object") {
+ theseArgs = theseArgs.concat([task.data]);
+ task = task.code;
+ }
+ var taskFunc = tryEval(task);
+ if (typeof(taskFunc) !== "function") {
+ throw new Error("Task must be a function! Source:\n" + task);
+ }
+ taskFunc.apply(target, theseArgs);
+ });
+ }
+ }
+
+ // Attempt eval() both with and without enclosing in parentheses.
+ // Note that enclosing coerces a function declaration into
+ // an expression that eval() can parse
+ // (otherwise, a SyntaxError is thrown)
+ function tryEval(code) {
+ var result = null;
+ try {
+ result = eval("(" + code + ")");
+ } catch(error) {
+ if (!(error instanceof SyntaxError)) {
+ throw error;
+ }
+ try {
+ result = eval(code);
+ } catch(e) {
+ if (e instanceof SyntaxError) {
+ throw error;
+ } else {
+ throw e;
+ }
+ }
+ }
+ return result;
+ }
+
+ function initSizing(el) {
+ var sizing = sizingPolicy(el);
+ if (!sizing)
+ return;
+
+ var cel = document.getElementById("htmlwidget_container");
+ if (!cel)
+ return;
+
+ if (typeof(sizing.padding) !== "undefined") {
+ document.body.style.margin = "0";
+ document.body.style.padding = paddingToCss(unpackPadding(sizing.padding));
+ }
+
+ if (sizing.fill) {
+ document.body.style.overflow = "hidden";
+ document.body.style.width = "100%";
+ document.body.style.height = "100%";
+ document.documentElement.style.width = "100%";
+ document.documentElement.style.height = "100%";
+ cel.style.position = "absolute";
+ var pad = unpackPadding(sizing.padding);
+ cel.style.top = pad.top + "px";
+ cel.style.right = pad.right + "px";
+ cel.style.bottom = pad.bottom + "px";
+ cel.style.left = pad.left + "px";
+ el.style.width = "100%";
+ el.style.height = "100%";
+
+ return {
+ getWidth: function() { return cel.getBoundingClientRect().width; },
+ getHeight: function() { return cel.getBoundingClientRect().height; }
+ };
+
+ } else {
+ el.style.width = px(sizing.width);
+ el.style.height = px(sizing.height);
+
+ return {
+ getWidth: function() { return cel.getBoundingClientRect().width; },
+ getHeight: function() { return cel.getBoundingClientRect().height; }
+ };
+ }
+ }
+
+ // Default implementations for methods
+ var defaults = {
+ find: function(scope) {
+ return querySelectorAll(scope, "." + this.name);
+ },
+ renderError: function(el, err) {
+ var $el = $(el);
+
+ this.clearError(el);
+
+ // Add all these error classes, as Shiny does
+ var errClass = "shiny-output-error";
+ if (err.type !== null) {
+ // use the classes of the error condition as CSS class names
+ errClass = errClass + " " + $.map(asArray(err.type), function(type) {
+ return errClass + "-" + type;
+ }).join(" ");
+ }
+ errClass = errClass + " htmlwidgets-error";
+
+ // Is el inline or block? If inline or inline-block, just display:none it
+ // and add an inline error.
+ var display = $el.css("display");
+ $el.data("restore-display-mode", display);
+
+ if (display === "inline" || display === "inline-block") {
+ $el.hide();
+ if (err.message !== "") {
+ var errorSpan = $("").addClass(errClass);
+ errorSpan.text(err.message);
+ $el.after(errorSpan);
+ }
+ } else if (display === "block") {
+ // If block, add an error just after the el, set visibility:none on the
+ // el, and position the error to be on top of the el.
+ // Mark it with a unique ID and CSS class so we can remove it later.
+ $el.css("visibility", "hidden");
+ if (err.message !== "") {
+ var errorDiv = $("
").addClass(errClass).css("position", "absolute")
+ .css("top", el.offsetTop)
+ .css("left", el.offsetLeft)
+ // setting width can push out the page size, forcing otherwise
+ // unnecessary scrollbars to appear and making it impossible for
+ // the element to shrink; so use max-width instead
+ .css("maxWidth", el.offsetWidth)
+ .css("height", el.offsetHeight);
+ errorDiv.text(err.message);
+ $el.after(errorDiv);
+
+ // Really dumb way to keep the size/position of the error in sync with
+ // the parent element as the window is resized or whatever.
+ var intId = setInterval(function() {
+ if (!errorDiv[0].parentElement) {
+ clearInterval(intId);
+ return;
+ }
+ errorDiv
+ .css("top", el.offsetTop)
+ .css("left", el.offsetLeft)
+ .css("maxWidth", el.offsetWidth)
+ .css("height", el.offsetHeight);
+ }, 500);
+ }
+ }
+ },
+ clearError: function(el) {
+ var $el = $(el);
+ var display = $el.data("restore-display-mode");
+ $el.data("restore-display-mode", null);
+
+ if (display === "inline" || display === "inline-block") {
+ if (display)
+ $el.css("display", display);
+ $(el.nextSibling).filter(".htmlwidgets-error").remove();
+ } else if (display === "block"){
+ $el.css("visibility", "inherit");
+ $(el.nextSibling).filter(".htmlwidgets-error").remove();
+ }
+ },
+ sizing: {}
+ };
+
+ // Called by widget bindings to register a new type of widget. The definition
+ // object can contain the following properties:
+ // - name (required) - A string indicating the binding name, which will be
+ // used by default as the CSS classname to look for.
+ // - initialize (optional) - A function(el) that will be called once per
+ // widget element; if a value is returned, it will be passed as the third
+ // value to renderValue.
+ // - renderValue (required) - A function(el, data, initValue) that will be
+ // called with data. Static contexts will cause this to be called once per
+ // element; Shiny apps will cause this to be called multiple times per
+ // element, as the data changes.
+ window.HTMLWidgets.widget = function(definition) {
+ if (!definition.name) {
+ throw new Error("Widget must have a name");
+ }
+ if (!definition.type) {
+ throw new Error("Widget must have a type");
+ }
+ // Currently we only support output widgets
+ if (definition.type !== "output") {
+ throw new Error("Unrecognized widget type '" + definition.type + "'");
+ }
+ // TODO: Verify that .name is a valid CSS classname
+
+ // Support new-style instance-bound definitions. Old-style class-bound
+ // definitions have one widget "object" per widget per type/class of
+ // widget; the renderValue and resize methods on such widget objects
+ // take el and instance arguments, because the widget object can't
+ // store them. New-style instance-bound definitions have one widget
+ // object per widget instance; the definition that's passed in doesn't
+ // provide renderValue or resize methods at all, just the single method
+ // factory(el, width, height)
+ // which returns an object that has renderValue(x) and resize(w, h).
+ // This enables a far more natural programming style for the widget
+ // author, who can store per-instance state using either OO-style
+ // instance fields or functional-style closure variables (I guess this
+ // is in contrast to what can only be called C-style pseudo-OO which is
+ // what we required before).
+ if (definition.factory) {
+ definition = createLegacyDefinitionAdapter(definition);
+ }
+
+ if (!definition.renderValue) {
+ throw new Error("Widget must have a renderValue function");
+ }
+
+ // For static rendering (non-Shiny), use a simple widget registration
+ // scheme. We also use this scheme for Shiny apps/documents that also
+ // contain static widgets.
+ window.HTMLWidgets.widgets = window.HTMLWidgets.widgets || [];
+ // Merge defaults into the definition; don't mutate the original definition.
+ var staticBinding = extend({}, defaults, definition);
+ overrideMethod(staticBinding, "find", function(superfunc) {
+ return function(scope) {
+ var results = superfunc(scope);
+ // Filter out Shiny outputs, we only want the static kind
+ return filterByClass(results, "html-widget-output", false);
+ };
+ });
+ window.HTMLWidgets.widgets.push(staticBinding);
+
+ if (shinyMode) {
+ // Shiny is running. Register the definition with an output binding.
+ // The definition itself will not be the output binding, instead
+ // we will make an output binding object that delegates to the
+ // definition. This is because we foolishly used the same method
+ // name (renderValue) for htmlwidgets definition and Shiny bindings
+ // but they actually have quite different semantics (the Shiny
+ // bindings receive data that includes lots of metadata that it
+ // strips off before calling htmlwidgets renderValue). We can't
+ // just ignore the difference because in some widgets it's helpful
+ // to call this.renderValue() from inside of resize(), and if
+ // we're not delegating, then that call will go to the Shiny
+ // version instead of the htmlwidgets version.
+
+ // Merge defaults with definition, without mutating either.
+ var bindingDef = extend({}, defaults, definition);
+
+ // This object will be our actual Shiny binding.
+ var shinyBinding = new Shiny.OutputBinding();
+
+ // With a few exceptions, we'll want to simply use the bindingDef's
+ // version of methods if they are available, otherwise fall back to
+ // Shiny's defaults. NOTE: If Shiny's output bindings gain additional
+ // methods in the future, and we want them to be overrideable by
+ // HTMLWidget binding definitions, then we'll need to add them to this
+ // list.
+ delegateMethod(shinyBinding, bindingDef, "getId");
+ delegateMethod(shinyBinding, bindingDef, "onValueChange");
+ delegateMethod(shinyBinding, bindingDef, "onValueError");
+ delegateMethod(shinyBinding, bindingDef, "renderError");
+ delegateMethod(shinyBinding, bindingDef, "clearError");
+ delegateMethod(shinyBinding, bindingDef, "showProgress");
+
+ // The find, renderValue, and resize are handled differently, because we
+ // want to actually decorate the behavior of the bindingDef methods.
+
+ shinyBinding.find = function(scope) {
+ var results = bindingDef.find(scope);
+
+ // Only return elements that are Shiny outputs, not static ones
+ var dynamicResults = results.filter(".html-widget-output");
+
+ // It's possible that whatever caused Shiny to think there might be
+ // new dynamic outputs, also caused there to be new static outputs.
+ // Since there might be lots of different htmlwidgets bindings, we
+ // schedule execution for later--no need to staticRender multiple
+ // times.
+ if (results.length !== dynamicResults.length)
+ scheduleStaticRender();
+
+ return dynamicResults;
+ };
+
+ // Wrap renderValue to handle initialization, which unfortunately isn't
+ // supported natively by Shiny at the time of this writing.
+
+ shinyBinding.renderValue = function(el, data) {
+ Shiny.renderDependencies(data.deps);
+ // Resolve strings marked as javascript literals to objects
+ if (!(data.evals instanceof Array)) data.evals = [data.evals];
+ for (var i = 0; data.evals && i < data.evals.length; i++) {
+ window.HTMLWidgets.evaluateStringMember(data.x, data.evals[i]);
+ }
+ if (!bindingDef.renderOnNullValue) {
+ if (data.x === null) {
+ el.style.visibility = "hidden";
+ return;
+ } else {
+ el.style.visibility = "inherit";
+ }
+ }
+ if (!elementData(el, "initialized")) {
+ initSizing(el);
+
+ elementData(el, "initialized", true);
+ if (bindingDef.initialize) {
+ var rect = el.getBoundingClientRect();
+ var result = bindingDef.initialize(el, rect.width, rect.height);
+ elementData(el, "init_result", result);
+ }
+ }
+ bindingDef.renderValue(el, data.x, elementData(el, "init_result"));
+ evalAndRun(data.jsHooks.render, elementData(el, "init_result"), [el, data.x]);
+ };
+
+ // Only override resize if bindingDef implements it
+ if (bindingDef.resize) {
+ shinyBinding.resize = function(el, width, height) {
+ // Shiny can call resize before initialize/renderValue have been
+ // called, which doesn't make sense for widgets.
+ if (elementData(el, "initialized")) {
+ bindingDef.resize(el, width, height, elementData(el, "init_result"));
+ }
+ };
+ }
+
+ Shiny.outputBindings.register(shinyBinding, bindingDef.name);
+ }
+ };
+
+ var scheduleStaticRenderTimerId = null;
+ function scheduleStaticRender() {
+ if (!scheduleStaticRenderTimerId) {
+ scheduleStaticRenderTimerId = setTimeout(function() {
+ scheduleStaticRenderTimerId = null;
+ window.HTMLWidgets.staticRender();
+ }, 1);
+ }
+ }
+
+ // Render static widgets after the document finishes loading
+ // Statically render all elements that are of this widget's class
+ window.HTMLWidgets.staticRender = function() {
+ var bindings = window.HTMLWidgets.widgets || [];
+ forEach(bindings, function(binding) {
+ var matches = binding.find(document.documentElement);
+ forEach(matches, function(el) {
+ var sizeObj = initSizing(el, binding);
+
+ var getSize = function(el) {
+ if (sizeObj) {
+ return {w: sizeObj.getWidth(), h: sizeObj.getHeight()}
+ } else {
+ var rect = el.getBoundingClientRect();
+ return {w: rect.width, h: rect.height}
+ }
+ };
+
+ if (hasClass(el, "html-widget-static-bound"))
+ return;
+ el.className = el.className + " html-widget-static-bound";
+
+ var initResult;
+ if (binding.initialize) {
+ var size = getSize(el);
+ initResult = binding.initialize(el, size.w, size.h);
+ elementData(el, "init_result", initResult);
+ }
+
+ if (binding.resize) {
+ var lastSize = getSize(el);
+ var resizeHandler = function(e) {
+ var size = getSize(el);
+ if (size.w === 0 && size.h === 0)
+ return;
+ if (size.w === lastSize.w && size.h === lastSize.h)
+ return;
+ lastSize = size;
+ binding.resize(el, size.w, size.h, initResult);
+ };
+
+ on(window, "resize", resizeHandler);
+
+ // This is needed for cases where we're running in a Shiny
+ // app, but the widget itself is not a Shiny output, but
+ // rather a simple static widget. One example of this is
+ // an rmarkdown document that has runtime:shiny and widget
+ // that isn't in a render function. Shiny only knows to
+ // call resize handlers for Shiny outputs, not for static
+ // widgets, so we do it ourselves.
+ if (window.jQuery) {
+ window.jQuery(document).on(
+ "shown.htmlwidgets shown.bs.tab.htmlwidgets shown.bs.collapse.htmlwidgets",
+ resizeHandler
+ );
+ window.jQuery(document).on(
+ "hidden.htmlwidgets hidden.bs.tab.htmlwidgets hidden.bs.collapse.htmlwidgets",
+ resizeHandler
+ );
+ }
+
+ // This is needed for the specific case of ioslides, which
+ // flips slides between display:none and display:block.
+ // Ideally we would not have to have ioslide-specific code
+ // here, but rather have ioslides raise a generic event,
+ // but the rmarkdown package just went to CRAN so the
+ // window to getting that fixed may be long.
+ if (window.addEventListener) {
+ // It's OK to limit this to window.addEventListener
+ // browsers because ioslides itself only supports
+ // such browsers.
+ on(document, "slideenter", resizeHandler);
+ on(document, "slideleave", resizeHandler);
+ }
+ }
+
+ var scriptData = document.querySelector("script[data-for='" + el.id + "'][type='application/json']");
+ if (scriptData) {
+ var data = JSON.parse(scriptData.textContent || scriptData.text);
+ // Resolve strings marked as javascript literals to objects
+ if (!(data.evals instanceof Array)) data.evals = [data.evals];
+ for (var k = 0; data.evals && k < data.evals.length; k++) {
+ window.HTMLWidgets.evaluateStringMember(data.x, data.evals[k]);
+ }
+ binding.renderValue(el, data.x, initResult);
+ evalAndRun(data.jsHooks.render, initResult, [el, data.x]);
+ }
+ });
+ });
+
+ invokePostRenderHandlers();
+ }
+
+
+ function has_jQuery3() {
+ if (!window.jQuery) {
+ return false;
+ }
+ var $version = window.jQuery.fn.jquery;
+ var $major_version = parseInt($version.split(".")[0]);
+ return $major_version >= 3;
+ }
+
+ /*
+ / Shiny 1.4 bumped jQuery from 1.x to 3.x which means jQuery's
+ / on-ready handler (i.e., $(fn)) is now asyncronous (i.e., it now
+ / really means $(setTimeout(fn)).
+ / https://jquery.com/upgrade-guide/3.0/#breaking-change-document-ready-handlers-are-now-asynchronous
+ /
+ / Since Shiny uses $() to schedule initShiny, shiny>=1.4 calls initShiny
+ / one tick later than it did before, which means staticRender() is
+ / called renderValue() earlier than (advanced) widget authors might be expecting.
+ / https://github.com/rstudio/shiny/issues/2630
+ /
+ / For a concrete example, leaflet has some methods (e.g., updateBounds)
+ / which reference Shiny methods registered in initShiny (e.g., setInputValue).
+ / Since leaflet is privy to this life-cycle, it knows to use setTimeout() to
+ / delay execution of those methods (until Shiny methods are ready)
+ / https://github.com/rstudio/leaflet/blob/18ec981/javascript/src/index.js#L266-L268
+ /
+ / Ideally widget authors wouldn't need to use this setTimeout() hack that
+ / leaflet uses to call Shiny methods on a staticRender(). In the long run,
+ / the logic initShiny should be broken up so that method registration happens
+ / right away, but binding happens later.
+ */
+ function maybeStaticRenderLater() {
+ if (shinyMode && has_jQuery3()) {
+ window.jQuery(window.HTMLWidgets.staticRender);
+ } else {
+ window.HTMLWidgets.staticRender();
+ }
+ }
+
+ if (document.addEventListener) {
+ document.addEventListener("DOMContentLoaded", function() {
+ document.removeEventListener("DOMContentLoaded", arguments.callee, false);
+ maybeStaticRenderLater();
+ }, false);
+ } else if (document.attachEvent) {
+ document.attachEvent("onreadystatechange", function() {
+ if (document.readyState === "complete") {
+ document.detachEvent("onreadystatechange", arguments.callee);
+ maybeStaticRenderLater();
+ }
+ });
+ }
+
+
+ window.HTMLWidgets.getAttachmentUrl = function(depname, key) {
+ // If no key, default to the first item
+ if (typeof(key) === "undefined")
+ key = 1;
+
+ var link = document.getElementById(depname + "-" + key + "-attachment");
+ if (!link) {
+ throw new Error("Attachment " + depname + "/" + key + " not found in document");
+ }
+ return link.getAttribute("href");
+ };
+
+ window.HTMLWidgets.dataframeToD3 = function(df) {
+ var names = [];
+ var length;
+ for (var name in df) {
+ if (df.hasOwnProperty(name))
+ names.push(name);
+ if (typeof(df[name]) !== "object" || typeof(df[name].length) === "undefined") {
+ throw new Error("All fields must be arrays");
+ } else if (typeof(length) !== "undefined" && length !== df[name].length) {
+ throw new Error("All fields must be arrays of the same length");
+ }
+ length = df[name].length;
+ }
+ var results = [];
+ var item;
+ for (var row = 0; row < length; row++) {
+ item = {};
+ for (var col = 0; col < names.length; col++) {
+ item[names[col]] = df[names[col]][row];
+ }
+ results.push(item);
+ }
+ return results;
+ };
+
+ window.HTMLWidgets.transposeArray2D = function(array) {
+ if (array.length === 0) return array;
+ var newArray = array[0].map(function(col, i) {
+ return array.map(function(row) {
+ return row[i]
+ })
+ });
+ return newArray;
+ };
+ // Split value at splitChar, but allow splitChar to be escaped
+ // using escapeChar. Any other characters escaped by escapeChar
+ // will be included as usual (including escapeChar itself).
+ function splitWithEscape(value, splitChar, escapeChar) {
+ var results = [];
+ var escapeMode = false;
+ var currentResult = "";
+ for (var pos = 0; pos < value.length; pos++) {
+ if (!escapeMode) {
+ if (value[pos] === splitChar) {
+ results.push(currentResult);
+ currentResult = "";
+ } else if (value[pos] === escapeChar) {
+ escapeMode = true;
+ } else {
+ currentResult += value[pos];
+ }
+ } else {
+ currentResult += value[pos];
+ escapeMode = false;
+ }
+ }
+ if (currentResult !== "") {
+ results.push(currentResult);
+ }
+ return results;
+ }
+ // Function authored by Yihui/JJ Allaire
+ window.HTMLWidgets.evaluateStringMember = function(o, member) {
+ var parts = splitWithEscape(member, '.', '\\');
+ for (var i = 0, l = parts.length; i < l; i++) {
+ var part = parts[i];
+ // part may be a character or 'numeric' member name
+ if (o !== null && typeof o === "object" && part in o) {
+ if (i == (l - 1)) { // if we are at the end of the line then evalulate
+ if (typeof o[part] === "string")
+ o[part] = tryEval(o[part]);
+ } else { // otherwise continue to next embedded object
+ o = o[part];
+ }
+ }
+ }
+ };
+
+ // Retrieve the HTMLWidget instance (i.e. the return value of an
+ // HTMLWidget binding's initialize() or factory() function)
+ // associated with an element, or null if none.
+ window.HTMLWidgets.getInstance = function(el) {
+ return elementData(el, "init_result");
+ };
+
+ // Finds the first element in the scope that matches the selector,
+ // and returns the HTMLWidget instance (i.e. the return value of
+ // an HTMLWidget binding's initialize() or factory() function)
+ // associated with that element, if any. If no element matches the
+ // selector, or the first matching element has no HTMLWidget
+ // instance associated with it, then null is returned.
+ //
+ // The scope argument is optional, and defaults to window.document.
+ window.HTMLWidgets.find = function(scope, selector) {
+ if (arguments.length == 1) {
+ selector = scope;
+ scope = document;
+ }
+
+ var el = scope.querySelector(selector);
+ if (el === null) {
+ return null;
+ } else {
+ return window.HTMLWidgets.getInstance(el);
+ }
+ };
+
+ // Finds all elements in the scope that match the selector, and
+ // returns the HTMLWidget instances (i.e. the return values of
+ // an HTMLWidget binding's initialize() or factory() function)
+ // associated with the elements, in an array. If elements that
+ // match the selector don't have an associated HTMLWidget
+ // instance, the returned array will contain nulls.
+ //
+ // The scope argument is optional, and defaults to window.document.
+ window.HTMLWidgets.findAll = function(scope, selector) {
+ if (arguments.length == 1) {
+ selector = scope;
+ scope = document;
+ }
+
+ var nodes = scope.querySelectorAll(selector);
+ var results = [];
+ for (var i = 0; i < nodes.length; i++) {
+ results.push(window.HTMLWidgets.getInstance(nodes[i]));
+ }
+ return results;
+ };
+
+ var postRenderHandlers = [];
+ function invokePostRenderHandlers() {
+ while (postRenderHandlers.length) {
+ var handler = postRenderHandlers.shift();
+ if (handler) {
+ handler();
+ }
+ }
+ }
+
+ // Register the given callback function to be invoked after the
+ // next time static widgets are rendered.
+ window.HTMLWidgets.addPostRenderHandler = function(callback) {
+ postRenderHandlers.push(callback);
+ };
+
+ // Takes a new-style instance-bound definition, and returns an
+ // old-style class-bound definition. This saves us from having
+ // to rewrite all the logic in this file to accomodate both
+ // types of definitions.
+ function createLegacyDefinitionAdapter(defn) {
+ var result = {
+ name: defn.name,
+ type: defn.type,
+ initialize: function(el, width, height) {
+ return defn.factory(el, width, height);
+ },
+ renderValue: function(el, x, instance) {
+ return instance.renderValue(x);
+ },
+ resize: function(el, width, height, instance) {
+ return instance.resize(width, height);
+ }
+ };
+
+ if (defn.find)
+ result.find = defn.find;
+ if (defn.renderError)
+ result.renderError = defn.renderError;
+ if (defn.clearError)
+ result.clearError = defn.clearError;
+
+ return result;
+ }
+})();
diff --git a/docs/articles/Introduction_files/profvis-0.3.6.9000/profvis.css b/docs/articles/Introduction_files/profvis-0.3.6.9000/profvis.css
new file mode 100644
index 0000000..2f63924
--- /dev/null
+++ b/docs/articles/Introduction_files/profvis-0.3.6.9000/profvis.css
@@ -0,0 +1,696 @@
+.profvis {
+ position: relative;
+}
+
+.profvis * {
+ /* Need to disable box-sizing:border-box if enabled from other CSS (like
+ Bootstrap) */
+ -webkit-box-sizing: content-box;
+ -moz-box-sizing: content-box;
+ box-sizing: content-box;
+}
+
+.profvis-footer .info-label {
+ cursor: default;
+}
+
+.profvis-panel1 {
+ left: 0px;
+ top: 23px;
+ position: absolute;
+}
+
+.profvis-panel1-vertical {
+ bottom: 0px;
+ width: 500px;
+ margin-bottom: 20px;
+}
+
+.profvis-panel1-horizontal {
+ height: 378px;
+ right: 0px;
+}
+
+.profvis-panel2 {
+ position: absolute;
+ right: 0px;
+ bottom: 0px;
+}
+
+.profvis-panel2-vertical {
+ top: 23px;
+ left: 508px;
+ margin-bottom: 20px;
+}
+
+.profvis-panel2-horizontal {
+ left: 0px;
+ top: 408px;
+ margin-bottom: 20px;
+}
+
+.profvis-splitbar {
+ position: absolute;
+ background-color: rgb(224, 224, 224);
+ border-color: #ddd;
+ border-style: solid;
+ background-repeat: no-repeat;
+ background-position: center;
+}
+
+.profvis-splitbar-vertical {
+ cursor: col-resize;
+ left: 500px;
+ width: 8px;
+ top: 23px;
+ bottom: 0px;
+ border-width: 0 1px;
+ background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAMAAAAHCAYAAADNufepAAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAADdJREFUeNpMi7ENADAIwwz/H8TEhMQz/JAupWqmyHGI7JoZIrscxMbBbhX+MMbTpG+x/UgCgzMA+a4RzyZ2yIIAAAAASUVORK5CYII=');
+}
+
+.profvis-splitbar-horizontal {
+ cursor: row-resize;
+ top: 400px;
+ height: 8px;
+ left: 0px;
+ right: 0px;
+ border-width: 0px 0;
+ background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAADCAYAAABfwxXFAAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAADZJREFUeNpi3LHv+BEGBgYGBob/EIqBkQEGGN+8ecOADfz//5+B5cylW0cgqjF1AgAAAP//AwCtfA4GqIXcdgAAAABJRU5ErkJggg==');
+}
+
+.profvis-status-bar {
+ position: absolute;
+ padding: 0px 0px;
+ top: 0;
+ left: 0;
+ right: 0;
+ height: 22px;
+ line-height: 18px;
+ border-bottom: 1px solid rgb(196, 201, 204);
+ background-color: rgb(248, 249, 248);
+ color: #444;
+ font-family: "Lucida Sans", "DejaVu Sans", "Lucida Grande", "Segoe UI", Verdana, Helvetica, sans-serif;
+ font-size: 11px;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ overflow: hidden;
+}
+
+.profvis-footer {
+ position: absolute;
+ padding: 0px 0px;
+ bottom: 0px;
+ left: 0;
+ right: 0;
+ height: 19px;
+ line-height: 18px;
+ border-top: 1px solid rgb(196, 201, 204);
+ background-color: rgb(248, 249, 248);
+ color: #444;
+ font-family: "Lucida Sans", "DejaVu Sans", "Lucida Grande", "Segoe UI", Verdana, Helvetica, sans-serif;
+ font-size: 11px;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ overflow: hidden;
+}
+
+.profvis-status-bar .info-block {
+ display: inline-block;
+ vertical-align: top;
+ width: 140px;
+ padding: 2px 11px 2px 11px;
+}
+
+.profvis-footer .info-block {
+ display: inline-block;
+ vertical-align: top;
+ padding: 1px 11px 1px 11px;
+}
+
+.profvis-footer .info-block-right {
+ display: inline-block;
+ vertical-align: top;
+ padding: 1px 11px 1px 11px;
+ float: right;
+}
+
+.profvis-status-bar .result-block {
+ width: auto;
+ cursor: pointer;
+}
+
+.profvis-status-bar .result-block-active {
+ width: auto;
+ background: rgb(227, 229, 230);
+}
+
+.profvis-status-bar .spacing-block {
+ display: inline-block;
+ width: 25px;
+}
+
+.profvis-status-bar .separator-block {
+ display: inline-block;
+ width: 1px;
+ text-align: center;
+}
+
+.profvis-status-bar .separator-block .separator-image {
+ width: 2px;
+ height: 26px;
+ margin-top: -2px;
+}
+
+.profvis-status-bar .options-button {
+ float: right;
+ color: #444;
+ text-decoration: none;
+ cursor: pointer;
+ padding: 2px 11px 2px 11px;
+}
+
+
+.profvis-options-panel {
+ float: left;
+ position: absolute;
+ right: 0;
+ top: 21px;
+ padding: 3px 6px;
+ border: 1px solid #999;
+ background-color: #fff;
+ font-family: "Lucida Sans", "DejaVu Sans", "Lucida Grande", "Segoe UI", Verdana, Helvetica, sans-serif;
+ font-size: 11px;
+ line-height: 170%;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+}
+
+.profvis-code {
+ position: absolute;
+ top: 0px;
+ left: 0;
+ bottom: 0;
+ right: 0;
+ overflow-y: auto;
+ border: 0px solid #ddd;
+}
+
+.profvis-flamegraph {
+ position: absolute;
+ right: 0;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ overflow: hidden;
+ border: 0px solid #ddd;
+ background: rgb(249, 249, 250);
+}
+
+table.profvis-table {
+ border-collapse: collapse;
+ font-family: "Lucida Sans", "DejaVu Sans", "Lucida Grande", "Segoe UI", Verdana, Helvetica, sans-serif;
+ font-size: 11px;
+ width: 100%;
+ text-align: left;
+ cursor: default;
+}
+
+table.profvis-table th {
+ background-color: rgb(249, 249, 250);
+ width: 14%;
+}
+
+table.profvis-table th.spacing {
+ width: 20px;
+}
+
+table.profvis-table th.filename {
+ font-family: monospace;
+ padding-left: 10px;
+ width: auto;
+}
+
+table.profvis-table th.percent {
+ text-align: center;
+}
+
+table.profvis-table tr {
+ border-top: 1px solid transparent;
+ border-bottom: 1px solid transparent;
+ vertical-align: top;
+}
+
+/* Need to use td for locked cells, so that the border color overrides the
+ border color from the row above. */
+table.profvis-table tr.locked > td {
+ border-top: 1px solid #444;
+ border-bottom: 1px solid #444;
+}
+
+table.profvis-table tr > td {
+ padding-top: 0;
+ padding-bottom: 0;
+}
+
+table.profvis-table tr.active {
+ background-color: #fdb;
+}
+
+table.profvis-table .linenum {
+ color: #aaa;
+ padding: 0 15px;
+ font-family: monospace;
+ width: 25px;
+}
+
+/* For unselectable and uncopyable text elements in table */
+table.profvis-table [data-pseudo-content]::before {
+ content: attr(data-pseudo-content);
+}
+
+table.profvis-table .code {
+ white-space: pre-wrap;
+ margin: 0;
+ min-height: 1.25em;
+ line-height: 1.25;
+ width: auto;
+ font-family: monospace;
+ background: transparent;
+}
+
+
+table.profvis-table .time, table.profvis-table .percent {
+ padding: 0 5px;
+ text-align: right;
+
+ min-width: 2em;
+ max-width: 2em;
+ overflow: hidden;
+
+ padding-right: 10px;
+}
+
+table.profvis-table .memory {
+ padding-right: 5px;
+}
+
+table.profvis-table th.time {
+ text-align: center;
+}
+
+table.profvis-table .memory {
+ padding: 0 5px;
+ text-align: right;
+
+ min-width: 2em;
+ max-width: 4em;
+ overflow: hidden;
+
+ padding-right: 10px;
+}
+
+table.profvis-table .memory-right {
+ text-align: left;
+}
+
+table.profvis-table th.memory {
+ text-align: center;
+}
+
+table.profvis-table .timebar-cell {
+ padding-left: 0;
+ border-left: 1px solid #444;
+ min-width: 3em;
+ width: 3em;
+}
+
+table.profvis-table .timebar-cell > .timebar {
+ background-color: #5A5A5A;
+ border-radius: 0px 2px 2px 0px;
+ line-height: 15px;
+}
+
+table.profvis-table .membar-left-cell {
+ padding-left: 0;
+ padding-right: 0;
+ border-left: 0px solid black;
+ min-width: 0.5em;
+ width: 0.5em;
+}
+
+table.profvis-table .membar-left-cell > .membar {
+ background-color: #A7A7A7;
+ float: right;
+ border-radius: 2px 0px 0px 2px;
+ line-height: 15px;
+}
+
+table.profvis-table .membar-right-cell {
+ padding-left: 0;
+ border-left: 1px solid black;
+ min-width: 1em;
+ width: 1em;
+}
+
+table.profvis-table .membar-right-cell > .membar {
+ background-color: #5A5A5A;
+ border-radius: 0px 2px 2px 0px;
+ line-height: 15px;
+}
+
+.profvis-flamegraph .background {
+ fill: rgb(249, 249, 250);
+}
+
+.profvis-flamegraph .cell .rect {
+ stroke: #000;
+ stroke-width: 0.25px;
+ fill: #fff;
+}
+
+.profvis-flamegraph .cell.active .rect {
+ stroke-width: 0.75px;
+ fill: #ddd;
+}
+
+.profvis-flamegraph .cell.highlighted .rect {
+ fill: #ffc;
+}
+
+.profvis-flamegraph .cell.highlighted.active .rect {
+ fill: #fdb;
+}
+
+.profvis-flamegraph .cell.output .rect {
+ fill: #eef;
+}
+
+.profvis-flamegraph .cell.gc .rect {
+ fill: #ccc;
+}
+
+.profvis-flamegraph .cell.stacktrace .rect {
+ fill: #eee;
+}
+.profvis-flamegraph .cell.stacktrace .profvis-label {
+ fill: #666;
+}
+
+.profvis-flamegraph .cell.locked {
+ font-weight: bold;
+}
+
+.profvis-flamegraph .cell.locked .rect {
+ stroke-width: 2px;
+}
+
+.profvis-flamegraph .cell .profvis-label {
+ font-family: monospace;
+ font-size: 11px;
+ cursor: default;
+}
+
+
+.profvis-flamegraph .axis text {
+ font: 10px sans-serif;
+}
+
+.profvis-flamegraph .axis path,
+.profvis-flamegraph .axis line {
+ fill: none;
+ stroke: #000;
+ shape-rendering: crispEdges;
+}
+
+
+.profvis-flamegraph .profvis-tooltip rect {
+ fill: rgb(249, 249, 250);
+ stroke: #000;
+ opacity: 0.75;
+ stroke-opacity: 0.75;
+ stroke-width: 0.5;
+}
+
+.profvis-flamegraph .profvis-tooltip text {
+ text-anchor: middle;
+ font-family: monospace;
+ font-size: 11px;
+}
+
+.profvis-infobox {
+ position: absolute;
+ left: 8px;
+ top: 8px;
+ opacity: 0.8;
+ border-radius: 3px;
+ color: #f8f8f8;
+ background-color: #333;
+ padding: 5px 10px;
+ font-family: "Lucida Sans", "DejaVu Sans", "Lucida Grande", "Segoe UI", Verdana, Helvetica, sans-serif;
+ font-size: 11px;
+ line-height: 100%;
+ pointer-events: none;
+ min-width: 280px;
+}
+
+.profvis-infobox table {
+ border-collapse: separate;
+ border-spacing: 2px;
+}
+
+
+.profvis-infobox table td {
+ padding: 1px;
+}
+
+.profvis-infobox .infobox-title {
+ font-weight: bold;
+}
+
+.profvis-message {
+ width: 100%;
+ height: 100%;
+ display: -ms-flexbox;
+ display: -webkit-flex;
+ display: flex;
+ -ms-flex-pack: center;
+ -webkit-justify-content: center;
+ justify-content: center;
+ -ms-flex-align: center;
+ -webkit-align-items: center;
+ align-items: center;
+ font-family: "Lucida Sans", "DejaVu Sans", "Lucida Grande", "Segoe UI", Verdana, Helvetica, sans-serif;
+ font-size: 11px;
+}
+
+.profvis-message div {
+ color: #444;
+ height: 25%;
+}
+
+.profvis-treetable {
+ top: 0px;
+ bottom: 0px;
+ left: 0px;
+ right: 0px;
+ position: absolute;
+ margin-top: 23px;
+ margin-bottom: 21px;
+ margin-right: 0px;
+ overflow: hidden;
+ font: 10px sans-serif;
+ color: #161616;
+ font-family: "Lucida Sans", "DejaVu Sans", "Lucida Grande", "Segoe UI", Verdana, Helvetica, sans-serif;
+ font-size: 11px;
+ overflow-y: auto;
+}
+
+.profvis-treetable .results {
+ width: 100%;
+ table-layout: fixed;
+}
+
+.profvis-treetable th {
+ font-weight: normal;
+ height: 18px;
+ background-color: #F8F9F8;
+ border-bottom: solid 1px #E4E4E4;
+ border-right: solid 1px #E4E4E4;
+ padding-left: 3px;
+ padding-right: 3px;
+}
+
+.profvis-treetable td {
+ height: 18px;
+ border-bottom: solid 1px #E4E4E4;
+ border-right: solid 1px #E4E4E4;
+ padding-left: 3px;
+ padding-right: 3px;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+
+.profvis-treetable .action {
+ width: 18px;
+}
+
+.profvis-treetable .memory {
+ width: 100px;
+ text-align: right;
+}
+
+.profvis-treetable th {
+ cursor: default;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ overflow: hidden;
+}
+
+.profvis-treetable th.memory {
+ text-align: center;
+}
+
+.profvis-treetable .time {
+ width: 100px;
+ text-align: right;
+}
+
+.profvis-treetable th.time {
+ text-align: center;
+}
+
+.profvis-treetable .count {
+ text-align: right;
+}
+
+.profvis-treetable th.count {
+ text-align: center;
+}
+
+.profvis-treetable th.code-label {
+ text-align: left;
+ padding-left: 5px;
+}
+
+.profvis-treetable td.label-pointer {
+ cursor: pointer;
+}
+
+.profvis-treetable .label-text {
+ display: inline-block;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.profvis-treetable .path {
+ text-align: left;
+}
+
+.profvis-treetable .treetable-expand > div {
+ display: inline-block;
+ width: 15px;
+}
+
+.profvis-treetable .treetable-expand > div > div{
+ width: 0px;
+ height: 0px;
+ margin-left: 3px;
+ margin-right: 6px;
+ border-top: 4px solid transparent;
+ border-left: 6px solid #161616;
+ border-bottom: 4px solid transparent;
+}
+
+.profvis-treetable .treetable-collapse > div {
+ display: inline-block;
+ width: 15px;
+}
+
+.profvis-treetable .treetable-collapse > div > div {
+ width: 0px;
+ height: 0px;
+ margin-left: 3px;
+ margin-right: 6px;
+ border-right: 4px solid transparent;
+ border-top: 6px solid #161616;
+ border-left: 4px solid transparent;
+ display: inline-block;
+}
+
+.profvis-treetable .time-info {
+ padding: 0px;
+ padding-right: 2px;
+ text-align: right;
+}
+
+.profvis-treetable .timebar {
+ width: 0px;
+ height: 14px;
+ background-color: #5A5A5A;
+ float: left;
+ border-radius: 2px 2px 2px 2px;
+ padding-top: 0px;
+ margin-top: 1px;
+}
+
+.profvis-treetable .timecell {
+ padding-top: 2px;
+ padding-right: 3px;
+}
+
+.profvis-treetable .memory-info {
+ padding-left: 0px;
+ padding-right: 2px;
+ text-align: right;
+}
+
+.profvis-treetable .memory-info-right {
+ padding-left: 2px;
+ padding-right: 0px;
+ text-align: left;
+}
+
+.profvis-treetable .memory-leftbar-wrapper {
+ float: left;
+ height: 14px;
+ width: 5px;
+}
+
+.profvis-treetable .memory-leftbar {
+ width: 2px;
+ height: 14px;
+ background-color: #A7A7A7;
+ float: right;
+ border-radius: 1px 0px 0px 1px;
+}
+
+.profvis-treetable .memory-rightbar {
+ width: 2px;
+ float: left;
+ height: 14px;
+ background-color: #5A5A5A;
+ border-radius: 0px 1px 1px 0px;
+}
+
+.profvis-treetable .memory-cell {
+}
+
+.profvis-treetable .memory-bar-container {
+ margin-right: 3px;
+}
+
+.profvis-treetable .time-bar-container {
+ margin-right: 3px;
+}
diff --git a/docs/articles/Introduction_files/profvis-0.3.6.9000/profvis.js b/docs/articles/Introduction_files/profvis-0.3.6.9000/profvis.js
new file mode 100644
index 0000000..af3e3a3
--- /dev/null
+++ b/docs/articles/Introduction_files/profvis-0.3.6.9000/profvis.js
@@ -0,0 +1,2656 @@
+/*jshint
+ undef:true,
+ browser:true,
+ devel: true,
+ jquery:true,
+ strict:false,
+ curly:false,
+ indent:2
+*/
+/*global profvis:true, d3, hljs */
+
+profvis = (function() {
+ var profvis = {};
+
+ profvis.render = function(el, message) {
+
+ function generateStatusBarButton(id, caption, active) {
+ var spacerImage = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAAUCAYAAACnOeyiAAAAXklEQVR42mNgAIL///8zMYSGhjIDGYIMIiIMvECGMwMDN4M4kFEDUqIIZKwDMdSBjAsghj6Q8QPEMAAy/lOBoQekv4AYKkDGfgZeXl4RICOLQUtLiw3IUAJJMQIZ7AC2tU2tXJxOYgAAAABJRU5ErkJggg==';
+
+ var buttonHtml =
+ '
';
+
+ return buttonHtml;
+ }
+
+ function generateStatusBar(el, onToogle) {
+ var $el = $(el);
+
+ el.innerHTML =
+ generateStatusBarButton('flameGraphButton', 'Flame Graph', true) +
+ generateStatusBarButton('treetableButton', 'Data', false) +
+ '';
+
+ $el.find("span.options-button").on("click", function(e) {
+ e.preventDefault();
+ e.stopPropagation();
+
+ vis.optionsPanel.toggleVisibility();
+ });
+
+ var setStatusBarButtons = function(e) {
+ $(".info-block").removeClass("result-block-active");
+ $(".info-block").addClass("result-block");
+ e.addClass("result-block-active");
+ };
+
+ $el.find("#flameGraphButton").on("click", function() {
+ setStatusBarButtons($(this));
+ onToogle("flamegraph");
+ });
+
+ $el.find("#treetableButton").on("click", function() {
+ setStatusBarButtons($(this));
+ onToogle("treetable");
+ });
+
+ return {
+ el: el
+ };
+ }
+
+ function generateFooter(el, onToogle) {
+ var $el = $(el);
+
+ el.innerHTML =
+ ' elements.
+ // This should usually be called with addItems(sel.enter()) instead
+ // of sel.enter().call(addItems), because the latter returns the original
+ // enter selection, not the selection of elements, and can't be
+ // used for chaining more function calls on the selection.
+ function addItems(enterSelection) {
+ var cells = enterSelection.append("g")
+ .attr("class", "cell")
+ .classed("highlighted", function(d) { return d.filename !== null; })
+ .call(addMouseEventHandlers);
+
+ // Add CSS classes for highlighting cells with labels that match particular
+ // regex patterns.
+ var highlightPatterns = d3.entries(message.highlight);
+ highlightPatterns.map(function(item) {
+ var cssClass = item.key;
+ var regexp = new RegExp(item.value);
+
+ cells.classed(cssClass, function(d) {
+ return d.label.search(regexp) !== -1;
+ });
+ });
+
+ cells.append("rect")
+ .attr("class", "rect");
+
+ cells.append("text")
+ .attr("class", "profvis-label")
+ .text(function(d) { return d.label; });
+
+ return cells;
+ }
+
+ // Given a selection, position the rects and labels, using a set of
+ // scales.
+ function positionItems(cells, scales) {
+ var xScale = scales.x;
+ var yScale = scales.y;
+ var depth = scales.getDepth;
+
+ cells.select("rect")
+ .attr("width", function(d) {
+ return xScale(d.endTime) - xScale(d.startTime);
+ })
+ .attr("height", yScale(0) - yScale(1))
+ .attr("x", function(d) { return xScale(d.startTime); })
+ .attr("y", function(d) { return yScale(depth(d)); });
+
+ cells.select("text")
+ .attr("x", function(d) {
+ // To place the labels, check if there's enough space to fit the
+ // label plus padding in the rect. (We already know the label fits
+ // without padding if we got here.)
+ // * If there's not enough space, simply center the label in the
+ // rect.
+ // * If there is enough space, keep the label within the rect, with
+ // padding. Try to left-align, keeping the label within the
+ // viewing area if possible.
+
+ // Padding on left and right
+ var pad = 2;
+
+ var textWidth = getLabelWidth(this, d.label.length);
+ var rectWidth = xScale(d.endTime) - xScale(d.startTime);
+
+ if (textWidth + pad*2 > rectWidth) {
+ return xScale(d.startTime) + (rectWidth - textWidth) / 2;
+ } else {
+ return Math.min(
+ Math.max(0, xScale(d.startTime)) + pad,
+ xScale(d.endTime) - textWidth - pad
+ );
+ }
+ })
+ .attr("y", function(d) { return yScale(depth(d) - 0.8); });
+
+ return cells;
+ }
+
+
+ // Redraw without a transition (regular panning and zooming)
+ function redrawImmediate() {
+ cells = selectActiveCells(scales);
+
+ cells.exit().remove();
+ addItems(cells.enter())
+ .call(addLockHighlightSelection, highlighter.currentLock())
+ .call(addActiveHighlightSelection, highlighter.currentActive());
+ cells.call(positionItems, scales);
+ cells.select('text')
+ .call(updateLabelVisibility);
+ svg.select(".x.axis").call(xAxis);
+ }
+
+ // Redraw for double-click zooming, where there's a transition
+ function redrawZoom(duration) {
+ // Figure out if we're zooming in or out. This will determine when we
+ // recalculate the label visibility: before or after the transition.
+ var prevExtent = prevScales.x.domain()[1] - prevScales.x.domain()[0];
+ var curExtent = scales.x.domain()[1] - scales.x.domain()[0];
+ var zoomIn = curExtent < prevExtent;
+
+ cells = selectActiveCells(scales);
+
+ // Phase 1
+ // Add the enter items, highlight them, and position them using the
+ // previous scales
+ addItems(cells.enter())
+ .call(addLockHighlightSelection, highlighter.currentLock())
+ .call(addActiveHighlightSelection, highlighter.currentActive())
+ .call(positionItems, prevScales);
+
+ // If zooming out, update label visibility. This will hide some labels
+ // now, before the transition, ensuring that they will never be larger
+ // than the box.
+ if (!zoomIn) {
+ cells.select('text')
+ .call(updateLabelVisibility);
+ }
+
+ // Phase 2
+ // Position the update (and enter) items using the new scales
+ cells
+ .transition().duration(duration)
+ .call(positionItems, scales);
+
+ // Position the exit items using the new scales
+ cells.exit()
+ .transition().duration(duration)
+ .call(positionItems, scales);
+
+ // Update x axis
+ svg.select(".x.axis")
+ .transition().duration(duration)
+ .call(xAxis);
+
+ // Phase 3
+ // If zooming in, update label visibility. This will hide some labels
+ // now, after the transition, ensuring that they will never be larger
+ // than the box.
+ if (zoomIn) {
+ cells.select('text')
+ .transition().delay(duration)
+ .call(updateLabelVisibility);
+ }
+
+ // Remove the exit items
+ cells.exit()
+ .transition().delay(duration)
+ .remove();
+ }
+
+ // Redraw when internal functions are hidden
+ function redrawCollapse(exitDuration, updateDuration) {
+ cells = selectActiveCells(scales);
+
+ // There are two subsets of the exit items:
+ // 1. Those that exit because depth is null. These should fade out.
+ // 2. Those that exit because they move off screen. These should wait
+ // for subset 1 to fade out, then move with a transition.
+ var fadeOutCells = cells.exit()
+ .filter(function(d) { return scales.getDepth(d) === null; });
+ var moveOutCells = cells.exit()
+ .filter(function(d) { return scales.getDepth(d) !== null; });
+
+ // Phase 1
+ // Add the enter items, highlight them, and position them using the
+ // previous scales
+ addItems(cells.enter())
+ .call(addLockHighlightSelection, highlighter.currentLock())
+ .call(addActiveHighlightSelection, highlighter.currentActive())
+ .call(positionItems, prevScales);
+
+ cells.select('text')
+ .call(updateLabelVisibility);
+
+ // Phase 2
+ // Fade out the items that have a null depth
+ fadeOutCells
+ .transition().duration(exitDuration)
+ .style("opacity", 0);
+
+ // Phase 3
+ // Position the update (and enter) items using the new scales
+ cells
+ .transition().delay(exitDuration).duration(updateDuration)
+ .call(positionItems, scales);
+
+ // Position the exit items that move out, using the new scales
+ moveOutCells
+ .transition().delay(exitDuration).duration(updateDuration)
+ .call(positionItems, scales);
+
+ // Phase 4
+ // Remove all the exit items
+ cells.exit()
+ .transition().delay(exitDuration + updateDuration)
+ .remove();
+ }
+
+ // Redraw when internal functions are un-hidden
+ function redrawUncollapse(updateDuration, enterDuration) {
+ cells = selectActiveCells(scales);
+
+ var enterCells = addItems(cells.enter());
+ // There are two subsets of the enter items:
+ // 1. Those that enter because they move on screen (but the previous
+ // depth was not null). These should move with a transition.
+ // 2. Those that enter because the previous depth was null. These
+ // should wait for subset 1 to move, then fade in.
+ var moveInCells = enterCells
+ .filter(function(d) { return prevScales.getDepth(d) !== null; });
+ var fadeInCells = enterCells
+ .filter(function(d) { return prevScales.getDepth(d) === null; });
+
+ // Phase 1
+ // Highlight and position the move-in items with the old scales
+ moveInCells
+ .call(addLockHighlightSelection, highlighter.currentLock())
+ .call(addActiveHighlightSelection, highlighter.currentActive())
+ .call(positionItems, prevScales);
+
+ cells.select('text')
+ .call(updateLabelVisibility);
+
+ // Phase 2
+ // Position the move-in, update, and exit items with a transition
+ moveInCells
+ .transition().duration(updateDuration)
+ .call(positionItems, scales);
+ cells
+ .transition().duration(updateDuration)
+ .call(positionItems, scales);
+ cells.exit()
+ .transition().duration(updateDuration)
+ .call(positionItems, scales);
+
+ // Phase 3
+ // Highlight and position the fade-in items, then fade in
+ fadeInCells
+ .call(addLockHighlightSelection, highlighter.currentLock())
+ .call(addActiveHighlightSelection, highlighter.currentActive())
+ .call(positionItems, scales)
+ .style("opacity", 0)
+ .transition().delay(updateDuration).duration(enterDuration)
+ .style("opacity", 1);
+
+ // Phase 4
+ // Remove the exit items
+ cells.exit()
+ .transition().delay(updateDuration + enterDuration)
+ .remove();
+ }
+
+
+ // Calculate whether to display label in each cell ----------------------
+
+ // Finding the dimensions of SVG elements is expensive. We'll reduce the
+ // calls getBoundingClientRect() by caching the dimensions.
+
+ // Cache the width of labels. This is a lookup table which, given the
+ // number of characters, gives the number of pixels. The label width
+ // never changes, so we can keep it outside of updateLabelVisibility().
+ var labelWidthTable = {};
+ function getLabelWidth(el, nchar) {
+ // Add entry if it doesn't already exist
+ if (labelWidthTable[nchar] === undefined) {
+ // If the text isn't displayed, then we can't get its width. Make
+ // sure it's visible, get the width, and then restore original
+ // display state.
+ var oldDisplay = el.style.display;
+ el.style.display = "inline";
+ labelWidthTable[nchar] = el.getBoundingClientRect().width;
+ el.style.display = oldDisplay;
+ }
+ return labelWidthTable[nchar];
+ }
+
+ // Show labels that fit in the corresponding rectangle, and hide others.
+ function updateLabelVisibility(labels) {
+ // Cache the width of rects. This is a lookup table which, given the
+ // timespan (width in data), gives the number of pixels. The width of
+ // rects changes with the x scale, so we have to rebuild the table each
+ // time the scale changes.
+ var rectWidthTable = {};
+ var x0 = scales.x(0);
+ function getRectWidth(time) {
+ // Add entry if it doesn't already exist
+ if (rectWidthTable[time] === undefined) {
+ rectWidthTable[time] = scales.x(time) - x0;
+ }
+ return rectWidthTable[time];
+ }
+
+ // Now calculate text and rect width for each cell.
+ labels.style("display", function(d) {
+ var labelWidth = getLabelWidth(this, d.label.length);
+ var boxWidth = getRectWidth(d.endTime - d.startTime);
+
+ return (labelWidth <= boxWidth) ? "" : "none";
+ });
+
+ return labels;
+ }
+
+
+ function onResize() {
+ updateContainerSize();
+
+ scales.x.range([0, dims.width]);
+ zoom.x(scales.x);
+
+ // Preserve distance from bottom, instead of from top (which is the
+ // default behavior).
+ scales.y.range([
+ dims.height,
+ dims.height - (domains.y[1] - domains.y[0]) * stackHeight
+ ]);
+ redrawImmediate();
+ }
+
+ // Attach mouse event handlers ------------------------------------
+ var dragging = false;
+
+ function addMouseEventHandlers(cells) {
+ cells
+ .on("mouseup", function(d) {
+ if (dragging) return;
+
+ // If it wasn't a drag, treat it as a click
+ vis.infoBox.show(d);
+ highlighter.click(d);
+ notifySourceFileMessage(d, "select");
+ })
+ .on("mouseover", function(d) {
+ if (dragging) return;
+
+ // If no label currently shown, display a tooltip
+ var label = this.querySelector(".profvis-label");
+ if (label.style.display === "none") {
+ var box = this.getBBox();
+ showTooltip(
+ d.label,
+ box.x + box.width / 2,
+ box.y - box.height
+ );
+ }
+
+ if (!highlighter.isLocked()) {
+ vis.infoBox.show(d);
+ highlighter.hover(d);
+ }
+ })
+ .on("mouseout", function(d) {
+ if (dragging) return;
+
+ hideTooltip();
+
+ if (!highlighter.isLocked()) {
+ vis.infoBox.hide();
+ highlighter.hover(null);
+ }
+ })
+ .on("dblclick.zoomcell", function(d) {
+ // When a cell is double-clicked, zoom x to that cell's width.
+ savePrevScales();
+
+ scales.x.domain(expandRange([d.startTime, d.endTime], zoomMargin));
+ zoom.x(scales.x);
+
+ redrawZoom(250);
+
+ notifySourceFileMessage(d, "open");
+ });
+
+ return cells;
+ }
+
+ // Tooltip --------------------------------------------------------
+ function showTooltip(label, x, y) {
+ var tooltip = container.append("g").attr("class", "profvis-tooltip");
+ var tooltipRect = tooltip.append("rect");
+ var tooltipLabel = tooltip.append("text")
+ .text(label)
+ .attr("x", x)
+ .attr("y", y + stackHeight * 0.2); // Shift down slightly for baseline
+
+ // Add box around label
+ var labelBox = tooltipLabel.node().getBBox();
+ var rectWidth = labelBox.width + 10;
+ var rectHeight = labelBox.height + 4;
+ tooltipRect
+ .attr("width", rectWidth)
+ .attr("height", rectHeight)
+ .attr("x", x - rectWidth / 2)
+ .attr("y", y - rectHeight / 2)
+ .attr("rx", 4) // Rounded corners -- can't set this in CSS
+ .attr("ry", 4);
+ }
+
+ function hideTooltip() {
+ container.select("g.profvis-tooltip").remove();
+ }
+
+
+ // Highlighting ---------------------------------------------------------
+
+ function addLockHighlight(d) {
+ addLockHighlightSelection(cells, d);
+ }
+
+ function clearLockHighlight() {
+ cells
+ .filter(".locked")
+ .classed({ locked: false });
+ }
+
+
+ function addActiveHighlight(d) {
+ if (!d) return;
+ addActiveHighlightSelection(cells, d);
+ }
+
+ function clearActiveHighlight() {
+ cells
+ .filter(".active")
+ .classed({ active: false });
+ }
+
+ // These are versions of addLockHighlight and addActiveHighlight which
+ // are only internally visible. It must be passed a selection of cells to
+ // perform the highlighting on. This can be more efficient because it can
+ // operate on just an enter selection instead of all cells.
+ function addLockHighlightSelection(selection, d) {
+ if (!d) return;
+
+ var target = d;
+ selection
+ .filter(function(d) { return d === target; } )
+ .classed({ locked: true })
+ .call(moveToFront);
+ }
+
+ function addActiveHighlightSelection(selection, d) {
+ if (!d) return;
+
+ var target = d;
+ if (target.filename && target.linenum) {
+ selection
+ .filter(function(d) {
+ // Check for filename and linenum match, and if provided, a label match.
+ var match = d.filename === target.filename &&
+ d.linenum === target.linenum;
+ if (!!target.label) {
+ match = match && (d.label === target.label);
+ }
+ return match;
+ })
+ .classed({ active: true });
+
+ } else if (target.label) {
+ // Don't highlight blocks for these labels
+ var exclusions = ["", "FUN"];
+ if (exclusions.some(function(x) { return target.label === x; })) {
+ return;
+ }
+
+ // If we only have the label, search for cells that match, but make sure
+ // to not select ones that have a filename and linenum.
+ selection
+ .filter(function(d) {
+ return d.label === target.label &&
+ d.filename === null &&
+ d.linenum === null;
+ })
+ .classed({ active: true });
+ }
+ }
+
+ // Move a D3 selection to front. If this is called on a selection, that
+ // selection should have been created with a data indexing function (e.g.
+ // data(data, function(d) { return ... })). Otherwise, the wrong object
+ // may be moved to the front.
+ function moveToFront(selection) {
+ return selection.each(function() {
+ this.parentNode.appendChild(this);
+ });
+ }
+
+
+ // Panning and zooming --------------------------------------------
+ // For panning and zooming x, d3.behavior.zoom does most of what we want
+ // automatically. For panning y, we can't use d3.behavior.zoom becuase it
+ // will also automatically add zooming, which we don't want. Instead, we
+ // need to use d3.behavior.drag and set the y domain appropriately.
+ var drag = d3.behavior.drag()
+ .on("drag", function() {
+ dragging = true;
+ var y = scales.y;
+ var ydom = y.domain();
+ var ydiff = y.invert(d3.event.dy) - y.invert(0);
+ y.domain([ydom[0] - ydiff, ydom[1] - ydiff]);
+ });
+
+
+ // For mousewheel zooming, we need to limit zoom amount. This is needed
+ // because in Firefox, zoom increments are too big. To do this, we limit
+ // scaleExtent before the first zoom event, and after each subsequent
+ // one.
+ //
+ // When zooming out, there's an additional limit: never zoom out past
+ // the original zoom span. The reason it's necessary to calculate this
+ // each time, instead of simply setting the scaleExtent() so that the
+ // lower bound is 1, is because other zoom events (like
+ // dblclick.zoomcell) are able to change the domain of scales.x, without
+ // changing the value of zoom.scale(). This means that the relationship
+ // between the zoom.scale() does not have a fixed linear relationship to
+ // the span of scales.x, and we have to recalculate it.
+ var maxZoomPerStep = 1.1;
+
+ function zoomOutLimit() {
+ var span = scales.x.domain()[1] - scales.x.domain()[0];
+ var startSpan = domains.x[1] - domains.x[0];
+ return Math.min(maxZoomPerStep, startSpan/span);
+ }
+
+ var zoom = d3.behavior.zoom()
+ .x(scales.x)
+ .on("zoomstart", function() {
+ zoom.scaleExtent([zoom.scale() / zoomOutLimit(), zoom.scale() * maxZoomPerStep]);
+ })
+ .on("zoom", function(e) {
+ redrawImmediate();
+ zoom.scaleExtent([zoom.scale() / zoomOutLimit(), zoom.scale() * maxZoomPerStep]);
+ });
+
+ // Register drag before zooming, because we need the drag to set the y
+ // scale before the zoom triggers a redraw.
+ svg
+ .on("mouseup", function(d) {
+ dragging = false;
+ })
+ .call(drag);
+
+ // Unlock selection when background is clicked, and zoom out when
+ // background is double-clicked.
+ backgroundRect
+ .on("mouseup", function(d) {
+ if (dragging) return;
+
+ // If it wasn't a drag, hide info box and unlock.
+ vis.infoBox.hide();
+ highlighter.click(null);
+ })
+ .on("dblclick.zoombackground", function() {
+ savePrevScales();
+
+ scales.x.domain(domains.x);
+ zoom.x(scales.x);
+
+ redrawZoom(250);
+ });
+
+
+ var zoomEnabled = false;
+ function disableZoom() {
+ if (zoomEnabled) {
+ svg.on(".zoom", null);
+ zoomEnabled = false;
+ }
+ }
+ function enableZoom() {
+ if (!zoomEnabled) {
+ svg
+ .call(zoom)
+ .on("dblclick.zoom", null); // Disable zoom's built-in double-click behavior
+ zoomEnabled = true;
+ }
+ }
+ enableZoom();
+
+ onResize();
+
+ return {
+ el: el,
+ onResize: onResize,
+ onUpdateInternals: onResize,
+ redrawImmediate: redrawImmediate,
+ redrawZoom: redrawZoom,
+ redrawCollapse: redrawCollapse,
+ redrawUncollapse: redrawUncollapse,
+ savePrevScales: savePrevScales,
+ useCollapsedDepth: useCollapsedDepth,
+ useUncollapsedDepth: useUncollapsedDepth,
+ addLockHighlight: addLockHighlight,
+ clearLockHighlight: clearLockHighlight,
+ addActiveHighlight: addActiveHighlight,
+ clearActiveHighlight: clearActiveHighlight,
+ disableZoom: disableZoom,
+ enableZoom: enableZoom
+ };
+ } // generateFlameGraph
+
+
+ function initInfoBox(el) {
+
+ function show(d) {
+ var label = d.label ? d.label : "";
+ var ref = (d.filename && d.linenum) ?
+ (d.filename + "#" + d.linenum) :
+ "(source unavailable)";
+
+ el.style.visibility = "";
+
+ el.innerHTML =
+ "" +
+ "
";
+ }
+
+ function hide() {
+ el.style.visibility = "hidden";
+ }
+
+ hide();
+
+ return {
+ el: el,
+ show: show,
+ hide: hide
+ };
+ }
+
+ // Generate the tree table ----------------------------------------
+ function generateTreetable(el) {
+ var content = d3.select(el);
+
+ var table = content.append("table")
+ .attr("class", "results")
+ .attr("cellspacing", "0")
+ .attr("cellpadding", "0");
+
+ table.append("col");
+ table.append("col")
+ .style("width", "120px");
+ table.append("col")
+ .style("width", "50px")
+ .attr("class", "treetable-memory");
+ table.append("col")
+ .style("width", "26px")
+ .attr("class", "treetable-memory");
+ table.append("col")
+ .style("width", "50px")
+ .attr("class", "treetable-memory");
+ table.append("col")
+ .style("width", "50px");
+ table.append("col")
+ .style("width", "40px");
+
+ var tableBody = table.append("tbody");
+
+ var headerRows = tableBody.append("tr");
+
+ headerRows.append("th")
+ .attr("class", "code-label")
+ .text("Code");
+
+ headerRows.append("th")
+ .attr("class", "path")
+ .text("File");
+
+ headerRows.append("th")
+ .attr("class", "treetable-memory memory")
+ .attr("colspan", "3")
+ .text("Memory (MB)");
+
+ headerRows.append("th")
+ .attr("class", "time")
+ .attr("colspan", "2")
+ .text("Time (ms)");
+
+ // Retrieve all nodes (n), recursevely, where check(n) == true.
+ function allTopNodes(nodes, check) {
+ var included = [];
+ nodes = nodes.slice();
+
+ while (nodes.length > 0) {
+ var node = nodes.shift();
+
+ if (check(node))
+ included.push(node);
+ else {
+ node.sumChildren.forEach(function(c1) {
+ nodes.unshift(c1);
+ });
+ }
+ }
+ return included;
+ }
+
+ // Is there one node (n), including root, where check(n) == true?
+ function oneNode(root, check) {
+ var nodes = [root];
+
+ while (nodes.length > 0) {
+ var n = nodes.shift();
+ if (check(n))
+ return true;
+
+ n.sumChildren.forEach(function(x) {
+ nodes.unshift(x);
+ });
+ }
+
+ return false;
+ }
+
+ function updateRowsDisplay(d) {
+ if (vis.hideInternals && d.isInternal)
+ return "none";
+ else if (!vis.hideInternals && d.isDescendant)
+ return "none";
+
+ var collapsed = false;
+ while (d.parent) {
+ d = d.parent;
+ if (d.collapsed) {
+ collapsed = true;
+ break;
+ }
+ }
+ return collapsed ? "none" : "";
+ }
+
+ function toggleTreeNode(d) {
+ if (!d.canExpand)
+ return;
+
+ var collapsed = d.collapsed;
+ if (collapsed === undefined) {
+ // Create a copy since we might insert the same node twice: once
+ // for the normal leaf the other one for a collapsed node.
+ var sumChildren = d.sumChildren.map(function(x) {
+ return jQuery.extend({}, x);
+ });
+
+ var childNodes = sumChildren.filter(function(x) {
+ return x.depthCollapsed !== null;
+ });
+
+ childNodes.forEach(function(x) {
+ x.isInternal = d.isInternal ? d.isInternal : false;
+ x.isDescendant = d.isDescendant ? d.isDescendant : false;
+ });
+
+ var internalChildNodes = sumChildren.filter(function(x) {
+ return x.depthCollapsed === null;
+ });
+
+ internalChildNodes.forEach(function(x) {
+ x.isInternal = true;
+ x.isDescendant = false;
+ });
+
+ var notInternalDescendantNodes = [];
+ if (!d.isInternal) {
+ notInternalDescendantNodes = allTopNodes(internalChildNodes, function(x) {
+ return x.depthCollapsed !== null && d.depth < x.depth;
+ });
+ }
+
+ notInternalDescendantNodes.forEach(function(x) {
+ x.isInternal = false;
+ x.isDescendant = true;
+ });
+
+ childNodes = childNodes.concat(internalChildNodes);
+ childNodes = childNodes.concat(notInternalDescendantNodes);
+
+ childNodes.forEach(function(n) {
+ n.visualDepth = d.visualDepth + 1;
+ n.parent = d;
+ });
+
+ vis.profTable = vis.profTable.concat(childNodes);
+ d.collapsed = false;
+
+ updateRows();
+
+ // Nodes are sorted "heaviest first"
+ if (childNodes.length == 1) toggleTreeNode(childNodes[0]);
+ }
+ else {
+ d.collapsed = !collapsed;
+ updateRows();
+ }
+ }
+
+ function updateLabelCells(labelCell) {
+ labelCell
+ .attr("nowrap", "true")
+ .style("padding-left", function(d) {
+ return (8 + 15 * (d.visualDepth - 1)) + "px";
+ })
+ .on("click", toggleTreeNode)
+ .attr("class", function(d) {
+ d.canExpand = false;
+ if (d.sumChildren) {
+ d.sumChildren.forEach(function(c) {
+ if (c.sumChildren.length > 0) {
+ if (!vis.hideInternals || oneNode(c, function(c1) { return c1.depthCollapsed !== null; }))
+ d.canExpand = true;
+ }
+ });
+ }
+
+ var collapsedClass = "";
+ if (d.canExpand)
+ collapsedClass = d.collapsed === undefined ? "treetable-expand" : d.collapsed ? "treetable-expand" : "treetable-collapse";
+
+ return "code-label " + (d.canExpand ? "label-pointer " + collapsedClass : "");
+ });
+ }
+
+ function updateRows() {
+ var rows = tableBody.selectAll("tr.treetable-row")
+ .data(vis.profTable, function(d) {
+ return d.id;
+ });
+
+ rows.exit()
+ .remove();
+
+ var updatedRows = rows
+ .style("display", updateRowsDisplay);
+
+ var updatedLabelCells = updatedRows.selectAll("td.code-label");
+ updateLabelCells(updatedLabelCells);
+
+ var newRows = rows.enter()
+ .append("tr")
+ .filter(function(d) {
+ if (vis.hideInternals && d.depthCollapsed === null)
+ return false;
+
+ return true;
+ })
+ .on("click", function(d) {
+ table.selectAll("tr")
+ .style("background-color", null);
+
+ this.style.backgroundColor = "rgb(241, 241, 241)";
+ notifySourceFileMessage(d, "select");
+ })
+ .style("display", updateRowsDisplay);
+
+ newRows
+ .attr("class", "treetable-row");
+
+ var labelCell = newRows.append("td");
+ updateLabelCells(labelCell);
+
+ var cellWrapper = labelCell.append("div");
+ cellWrapper.append("div");
+
+ labelCell.append("div")
+ .attr("class", "label-text")
+ .text(function(d) { return d.label; });
+
+ newRows.append("td")
+ .attr("class", "path")
+ .text(function(d) {
+ var lastSlash = d.filename ? d.filename.lastIndexOf("/") : -1;
+ if (lastSlash >= 0)
+ return d.filename.substr(lastSlash + 1);
+
+ return d.filename;
+ });
+
+ newRows.append("td")
+ .attr("class", "treetable-memory memory-info")
+ .text(function(d) {
+ return roundOneDecimal(d.sumMemDealloc);
+ });
+
+ var memoryBarContainer = newRows.append("td")
+ .attr("class", "treetable-memory memory-bar-container");
+
+ var memoryLeftCell = memoryBarContainer.append("div")
+ .attr("class", "memory-leftbar-wrapper");
+
+ memoryLeftCell.append("div")
+ .attr("class", "memory-leftbar")
+ .style("width", function(d) {
+ return 1 + Math.min(Math.abs(Math.min(Math.round(d.propMemDealloc * 5), 0)), 5) + "px";
+ });
+
+ memoryBarContainer.append("div")
+ .attr("class", "memory-rightbar")
+ .style("width", function(d) {
+ return 1 + Math.min(Math.max(Math.round(d.propMemAlloc * 13), 0), 13) + "px";
+ });
+
+ newRows.append("td")
+ .attr("class", "treetable-memory memory-info-right")
+ .text(function(d) {
+ return roundOneDecimal(d.sumMemAlloc);
+ });
+
+ newRows.append("td")
+ .attr("class", "time-info")
+ .text(function(d) {
+ return d.sumTime;
+ });
+
+ var timeCell = newRows.append("td")
+ .attr("class", "time-bar-container");
+
+ timeCell.append("div")
+ .attr("class", "timebar")
+ .style("width", function(d) {
+ return Math.round(d.propTime * 20) + "px";
+ });
+
+ var unorderedRows = d3.selectAll("tr.treetable-row")
+ .data(vis.profTable, function(d) {
+ return d.id;
+ });
+
+ unorderedRows.sort(function(a,b) {
+ return (a.id < b.id) ? -1 : (a.id == b.id ? 0 : 1);
+ });
+
+ useMemoryResults();
+ }
+
+ var buildProfTable = function (profTree) {
+ var head = jQuery.extend({}, profTree);
+ var nodes = [head];
+
+ var aggregateChildren = function(node) {
+ var nameMap = {};
+ node.children.forEach(function(c) {
+ var nameMapEntry = nameMap[c.label];
+ if (!nameMapEntry) {
+ nameMapEntry = jQuery.extend({}, c);
+ nameMapEntry.sumTime = c.endTime - c.startTime;
+ nameMapEntry.sumChildren = [];
+ nameMapEntry.children = [];
+ nameMapEntry.parent = node;
+ nameMapEntry.sumCount = 1;
+ }
+ else {
+ nameMapEntry.sumMem = nameMapEntry.sumMem + c.sumMem;
+ nameMapEntry.sumMemDealloc = nameMapEntry.sumMemDealloc + c.sumMemDealloc;
+ nameMapEntry.sumMemAlloc = nameMapEntry.sumMemAlloc + c.sumMemAlloc;
+ nameMapEntry.sumTime = nameMapEntry.sumTime + (c.endTime - c.startTime);
+ nameMapEntry.sumCount = nameMapEntry.sumCount + 1;
+ }
+
+ nameMapEntry.propMem = nameMapEntry.sumMem / vis.totalMem;
+ nameMapEntry.propMemDealloc = nameMapEntry.sumMemDealloc / vis.totalMem;
+ nameMapEntry.propMemAlloc = nameMapEntry.sumMemAlloc / vis.totalMem;
+ nameMapEntry.propTime = nameMapEntry.sumTime / vis.totalTime;
+
+ c.children.forEach(function(e) {
+ nameMapEntry.children.push(e);
+ });
+
+ nameMap[c.label] = nameMapEntry;
+ });
+
+ var childrenSum = [];
+ for (var label in nameMap) {
+ childrenSum.push(nameMap[label]);
+ }
+
+ // Sort by time descending
+ childrenSum.sort(function(a, b) { return b.sumTime - a.sumTime });
+ return childrenSum;
+ };
+
+ function addToNodesAt(c, i) {
+ nodes.splice(i, 0, c);
+ }
+
+ var id = 0;
+ while (nodes.length > 0) {
+ var node = nodes.shift();
+
+ node.id = id;
+ id = id + 1;
+
+ node.sumChildren = aggregateChildren(node);
+
+ // Processing in order is important to preserve order of IDs!
+ node.sumChildren.forEach(addToNodesAt);
+ }
+
+ return head.sumChildren;
+ };
+
+ function useMemoryResults() {
+ d3.selectAll(".treetable-memory").style("display", vis.hideMemory ? "none" : "");
+ }
+
+ vis.profTable = buildProfTable(vis.profTree);
+ vis.profTable.forEach(function(e) {
+ e.visualDepth = 1;
+ });
+
+ updateRows();
+
+ return {
+ el: el,
+ onResize: updateRows,
+ onOptionsChange: updateRows,
+ onUpdateInternals: function() {
+
+ },
+ useMemoryResults: useMemoryResults
+ };
+ }
+
+ function enableScroll() {
+ vis.codeTable.enableScroll();
+ vis.flameGraph.enableZoom();
+ }
+
+ function disableScroll() {
+ vis.codeTable.disableScroll();
+ vis.flameGraph.disableZoom();
+ }
+
+
+ // Set up resizing --------------------------------------------------------
+
+ // This is used as a jQuery event namespace so that we can remove the window
+ // resize handler on subsequent calls to initResizing(). Not elegant, but it
+ // gets the job done.
+ var resizeCallbackNamespace = randomString(10);
+
+ // Resize panel1 and panel2 to 50% of available space and add callback
+ // for window resizing.
+ function initResizing() {
+ var $el = $(vis.el);
+ var $panel1 = $el.children(".profvis-panel1");
+ var $panel2 = $el.children(".profvis-panel2");
+ var $splitBar = $el.children(".profvis-splitbar");
+ var $statusBar = $el.children(".profvis-status-bar");
+
+ // Clear any existing positioning that may have happened from previous
+ // calls to this function and the callbacks that it sets up.
+ $panel1.removeAttr("style");
+ $panel2.removeAttr("style");
+ $splitBar.removeAttr("style");
+ $statusBar.removeAttr("style");
+
+ // CSS class suffix for split direction
+ var splitClass = (vis.splitDir === "h") ? "horizontal" : "vertical";
+
+ // Remove existing horizontal/vertical class and add the correct class back.
+ $panel1.removeClass("profvis-panel1-horizontal profvis-panel1-vertical");
+ $panel2.removeClass("profvis-panel2-horizontal profvis-panel2-vertical");
+ $splitBar.removeClass("profvis-splitbar-horizontal profvis-splitbar-vertical");
+ $panel1.addClass("profvis-panel1-" + splitClass);
+ $panel2.addClass("profvis-panel2-" + splitClass);
+ $splitBar.addClass("profvis-splitbar-" + splitClass);
+
+
+ var splitBarGap;
+ var margin;
+ // Record the proportions from the previous call to resizePanels. This is
+ // needed when we resize the window to preserve the same proportions.
+ var lastSplitProportion;
+
+ if (vis.splitDir === "v") {
+ // Record the gap between the split bar and the objects to left and right
+ splitBarGap = {
+ left: $splitBar.offset().left - offsetRight($panel1),
+ right: $panel2.offset().left - offsetRight($splitBar)
+ };
+
+ // Capture the initial distance from the left and right of container element
+ margin = {
+ left: $panel1.position().left,
+ right: $el.innerWidth() - positionRight($panel2)
+ };
+
+ } else if (vis.splitDir === "h") {
+ splitBarGap = {
+ top: $splitBar.offset().top - offsetBottom($panel1),
+ bottom: $panel2.offset().top - offsetBottom($splitBar)
+ };
+
+ margin = {
+ top: $panel1.position().top,
+ bottom: $el.innerWidth() - positionBottom($panel2)
+ };
+ }
+
+ // Resize the panels. splitProportion is a number from 0-1 representing the
+ // horizontal position of the split bar.
+ function resizePanels(splitProportion) {
+ if (!splitProportion)
+ splitProportion = lastSplitProportion;
+
+ if (vis.splitDir === "v") {
+ var innerWidth = offsetRight($panel2) - $panel1.offset().left;
+
+ $splitBar.offset({
+ left: $panel1.offset().left + innerWidth * splitProportion -
+ $splitBar.outerWidth()/2
+ });
+
+ // Size and position the panels
+ $panel1.outerWidth($splitBar.position().left - splitBarGap.left -
+ margin.left);
+ $panel2.offset({ left: offsetRight($splitBar) + splitBarGap.right });
+
+ } else if (vis.splitDir === "h") {
+ var innerHeight = offsetBottom($panel2) - $panel1.offset().top;
+
+ $splitBar.offset({
+ top: $panel1.offset().top + innerHeight * splitProportion -
+ $splitBar.outerHeight()/2
+ });
+
+ // Size and position the panels
+ $panel1.outerHeight($splitBar.position().top - splitBarGap.top -
+ margin.top);
+ $panel2.offset({ top: offsetBottom($splitBar) + splitBarGap.bottom });
+ }
+
+ lastSplitProportion = splitProportion;
+ }
+
+ // Initially, set widths to 50/50
+ // For the first sizing, we don't need to call vis.flameGraph.onResize()
+ // because this happens before the flame graph is generated.
+ resizePanels(0.5);
+
+ var resizePanelsDebounced = debounce(function() {
+ resizePanels(lastSplitProportion);
+ vis.activeViews.forEach(function(e) {
+ if (e.onResize) e.onResize();
+ });
+ }, 250);
+
+ // Clear old resize handler and add new one. We use a namespace for this
+ // visualization to make sure not to delete handlers for other profvis
+ // visualizations on the same page (this can happen with Rmd documents).
+ $(window).off("resize.profvis." + resizeCallbackNamespace);
+ $(window).on("resize.profvis." + resizeCallbackNamespace, resizePanelsDebounced);
+
+ // Get current proportional position of split bar
+ function splitProportion() {
+ var splitCenter;
+
+ if (vis.splitDir === "v") {
+ splitCenter = $splitBar.offset().left - $panel1.offset().left +
+ $splitBar.outerWidth()/2;
+ var innerWidth = offsetRight($panel2) - $panel1.offset().left;
+ return splitCenter / innerWidth;
+
+ } else if (vis.splitDir === "h") {
+ splitCenter = $splitBar.offset().top - $panel1.offset().top +
+ $splitBar.outerHeight()/2;
+ var innerHeight = offsetBottom($panel2) - $panel1.offset().top;
+ return splitCenter / innerHeight;
+ }
+ }
+
+ function positionRight($el) {
+ return $el.position().left + $el.outerWidth();
+ }
+ function offsetRight($el) {
+ return $el.offset().left + $el.outerWidth();
+ }
+ function positionBottom($el) {
+ return $el.position().top + $el.outerHeight();
+ }
+ function offsetBottom($el) {
+ return $el.offset().top + $el.outerHeight();
+ }
+
+ // Enable dragging of the split bar ---------------------------------------
+ (function() {
+ var dragging = false;
+ // For vertical split (left-right dragging)
+ var startDragX;
+ var startOffsetLeft;
+ // For horizontal split (up-down dragging)
+ var startDragY;
+ var startOffsetTop;
+
+ var stopDrag = function(e) {
+ if (!dragging) return;
+ dragging = false;
+
+ document.removeEventListener("mousemove", drag);
+ document.removeEventListener("mouseup", stopDrag);
+
+ $splitBar.css("opacity", "");
+
+ if ((vis.splitDir === "v" && e.pageX - startDragX === 0) ||
+ (vis.splitDir === "h" && e.pageY - startDragY === 0)) {
+ return;
+ }
+
+ resizePanels(splitProportion());
+ vis.flameGraph.onResize();
+ };
+
+ var startDrag = function(e) {
+ // Don't start another drag if we're already in one.
+ if (dragging) return;
+ dragging = true;
+ pauseEvent(e);
+
+ $splitBar.css("opacity", 0.75);
+
+ if (vis.splitDir === "v") {
+ startDragX = e.pageX;
+ startOffsetLeft = $splitBar.offset().left;
+ } else {
+ startDragY = e.pageY;
+ startOffsetTop = $splitBar.offset().top;
+ }
+
+ document.addEventListener("mousemove", drag);
+ document.addEventListener("mouseup", stopDrag);
+ };
+
+ var drag = function(e) {
+ if (!dragging) return;
+ pauseEvent(e);
+
+ if (vis.splitDir === "v") {
+ var dx = e.pageX - startDragX;
+ if (dx === 0)
+ return;
+
+ // Move the split bar
+ $splitBar.offset({ left: startOffsetLeft + dx });
+
+ } else if (vis.splitDir === "h") {
+ var dy = e.pageY - startDragY;
+ if (dy === 0)
+ return;
+
+ // Move the split bar
+ $splitBar.offset({ top: startOffsetTop + dy });
+ }
+ };
+
+ // Stop propogation so that we don't select text while dragging
+ function pauseEvent(e){
+ if(e.stopPropagation) e.stopPropagation();
+ if(e.preventDefault) e.preventDefault();
+ e.cancelBubble = true;
+ e.returnValue = false;
+ return false;
+ }
+
+ // Remove existing event listener from previous calls to initResizing().
+ $splitBar.off("mousedown.profvis");
+ $splitBar.on("mousedown.profvis", startDrag);
+ })();
+
+
+ return {
+ resizePanels: resizePanels
+ };
+ }
+
+
+ var prof = prepareProfData(message.prof, message.interval);
+
+ var vis = {
+ el: el,
+ prof: prof,
+ profTree: getProfTree(prof),
+ interval: message.interval,
+ totalTime: getTotalTime(prof),
+ totalMem: getTotalMemory(prof),
+ files: message.files,
+ aggLabelTimes: getAggregatedLabelTimes(prof),
+ fileLineStats: getFileLineStats(prof, message.files),
+ profTable: [],
+
+ // Objects representing each component
+ statusBar: null,
+ optionsPanel: null,
+ codeTable: null,
+ flameGraph: null,
+ infoBox: null,
+ treetable: null,
+ activeViews: [],
+
+ // Functions to enable/disable responding to scrollwheel events
+ enableScroll: enableScroll,
+ disableScroll: disableScroll,
+
+ splitDir: message.split,
+ hideInternals: true,
+ hideMemory: false,
+
+ resizePanels: null
+ };
+
+
+ // Render the objects ---------------------------------------------
+
+ var statusBarEl = document.createElement("div");
+ statusBarEl.className = "profvis-status-bar";
+ vis.el.appendChild(statusBarEl);
+
+ // Container panels - top/bottom or left/right
+ var panel1 = document.createElement("div");
+ panel1.className = "profvis-panel1";
+ vis.el.appendChild(panel1);
+
+ var panel2 = document.createElement("div");
+ panel2.className = "profvis-panel2";
+ vis.el.appendChild(panel2);
+
+ var splitBarEl = document.createElement("div");
+ splitBarEl.className = "profvis-splitbar";
+ vis.el.appendChild(splitBarEl);
+
+ var footerEl = document.createElement("div");
+ footerEl.className = "profvis-footer";
+ vis.el.appendChild(footerEl);
+
+ // Items in the panels
+ var codeTableEl = document.createElement("div");
+ codeTableEl.className = "profvis-code";
+ panel1.appendChild(codeTableEl);
+
+ var flameGraphEl = document.createElement("div");
+ flameGraphEl.className = "profvis-flamegraph";
+ panel2.appendChild(flameGraphEl);
+
+ var infoBoxEl = document.createElement("div");
+ infoBoxEl.className = "profvis-infobox";
+ panel2.appendChild(infoBoxEl);
+
+ var treetableEl = document.createElement("div");
+ treetableEl.className = "profvis-treetable";
+ treetableEl.style.display = "none";
+ vis.el.appendChild(treetableEl);
+
+ var optionsPanelEl = document.createElement("div");
+ optionsPanelEl.className = "profvis-options-panel";
+ vis.el.appendChild(optionsPanelEl);
+
+ // Efficient to properly size panels before the code + flamegraph are
+ // rendered, so that we don't have to re-render.
+ var resize = initResizing();
+ vis.resizePanels = resize.resizePanels;
+
+ var hideViews = function() {
+ splitBarEl.style.display = "none";
+ panel1.style.display = "none";
+ panel2.style.display = "none";
+ treetableEl.style.display = "none";
+ };
+
+ var toggleViews = function(view) {
+ hideViews();
+
+ switch (view) {
+ case "flamegraph":
+ splitBarEl.style.display = "block";
+ panel1.style.display = "block";
+ panel2.style.display = "block";
+
+ vis.activeViews = [vis.flameGraph, vis.codeTable];
+ vis.resizePanels();
+ break;
+ case "treetable":
+ if (!vis.treetable) {
+ vis.treetable = generateTreetable(treetableEl);
+ }
+
+ treetableEl.style.display = "block";
+
+ vis.activeViews = [vis.treetable];
+ break;
+ }
+
+ vis.activeViews.forEach(function(e) {
+ if (e.onResize) e.onResize();
+ });
+ };
+
+ var onOptionsChange = function(option, checked) {
+ switch (option)
+ {
+ case "split": {
+ vis.splitDir = checked ? "h" : "v";
+ // Check that flame graph is visible
+ if ($.inArray(vis.flameGraph, vis.activeViews) !== -1) {
+ initResizing();
+ vis.flameGraph.onResize();
+ }
+ break;
+ }
+ case "internals": {
+ vis.flameGraph.savePrevScales();
+
+ vis.hideInternals = checked;
+ if (checked) {
+ vis.flameGraph.useCollapsedDepth();
+ vis.flameGraph.redrawCollapse(400, 400);
+ } else {
+ vis.flameGraph.useUncollapsedDepth();
+ vis.flameGraph.redrawUncollapse(400, 250);
+ }
+
+ vis.activeViews.forEach(function(e) {
+ if (e.onOptionsChange) e.onOptionsChange();
+ });
+
+ break;
+ }
+ case "memory": {
+ vis.hideMemory = checked;
+ vis.activeViews.forEach(function(e) {
+ if (e.useMemoryResults) e.useMemoryResults();
+ });
+ break;
+ }
+ }
+ };
+
+ // Create the UI components
+ vis.statusBar = generateStatusBar(statusBarEl, toggleViews);
+ vis.footer = generateFooter(footerEl);
+ vis.optionsPanel = generateOptionsPanel(optionsPanelEl, onOptionsChange);
+ vis.codeTable = generateCodeTable(codeTableEl);
+ vis.flameGraph = generateFlameGraph(flameGraphEl);
+ vis.infoBox = initInfoBox(infoBoxEl);
+ vis.treetable = null;
+ vis.activeViews = [vis.flameGraph, vis.codeTable];
+
+ // If any depth collapsing occured, enable the "hide internal" checkbox.
+ if (prof.some(function(d) { return d.depth !== d.depthCollapsed; })) {
+ vis.optionsPanel.enableHideInternal();
+ }
+
+ // Start with scrolling disabled because of mousewheel scrolling issue
+ disableScroll();
+
+ // Make the vis object accessible via the DOM element
+ $(el).data("profvis", vis);
+
+ return vis;
+ }; // profvis.render()
+
+ // Calculate amount of time spent on each line of code. Returns nested objects
+ // grouped by file, and then by line number.
+ function getFileLineStats(prof, files) {
+ // Drop entries with null or "" filename
+ prof = prof.filter(function(row) {
+ return row.filename !== null && row.filename !== "";
+ });
+
+ // Gather line-by-line file contents
+ var fileLineStats = files.map(function(file) {
+ // Create array of objects with info for each line of code.
+ var lines = file.content.split("\n");
+ var lineData = [];
+ var filename = file.filename;
+ var normpath = file.normpath;
+ for (var i=0; i 0) {
+ node.depthCollapsed = null;
+ } else {
+ node.depthCollapsed = curCollapsedDepth;
+ curCollapsedDepth++;
+ }
+
+ if (node.label === "..stacktraceon..") {
+ stacktraceOffCount--;
+ }
+
+ // Recurse
+ node.children.forEach(function(x) {
+ calculateDepths(x, curCollapsedDepth, stacktraceOffCount);
+ });
+ }
+ }
+
+
+ // Transform column-oriented data (an object with arrays) to row-oriented data
+ // (an array of objects).
+ function colToRows(x) {
+ var colnames = d3.keys(x);
+ if (colnames.length === 0)
+ return [];
+
+ var newdata = [];
+ for (var i=0; i < x[colnames[0]].length; i++) {
+ var row = {};
+ for (var j=0; j < colnames.length; j++) {
+ var colname = colnames[j];
+ row[colname] = x[colname][i];
+ }
+ newdata[i] = row;
+ }
+
+ return newdata;
+ }
+
+ // Given an array with two values (a min and max), return an array with the
+ // range expanded by `amount`.
+ function expandRange(range, amount) {
+ var adjust = amount * (range[1] - range[0]);
+ return [
+ range[0] - adjust,
+ range[1] + adjust
+ ];
+ }
+
+
+ // Escape an HTML string.
+ function escapeHTML(text) {
+ return text
+ .replace(/&/g, "&")
+ .replace(//g, ">")
+ .replace(/"/g, """)
+ .replace(/'/g, "'");
+ }
+
+ // This returns the current page URL without any trailing hash. Should be
+ // used in url() references in SVGs to avoid problems when there's a Articles • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Articles • tidyft
+
-
-
-
-
Authors • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Authors and Citation • tidyft
-
+
-
-
-
-
' + caption + '
' +
+ 'Sample Interval: ' +
+ vis.interval + 'ms
' +
+ '' +
+ // '' + (Math.round(vis.totalMem * 100) / 100) + 'MB' +
+ // ' / ' +
+ '' + vis.totalTime + 'ms' +
+ '
';
+
+ return {
+ el: el
+ };
+ }
+
+ function generateOptionsPanel(el, onOptionsChange) {
+ var $el = $(el);
+
+ el.innerHTML =
+ '' +
+ ' Split horizontally' +
+ '
' +
+ '' +
+ '' +
+ '';
+
+ // Toggle the appearance of a checkbox and return the new checked state.
+ function toggleCheckbox($checkbox) {
+ // Use attr() instead of data(), because the latter tries to coerce to
+ // numbers, which complicates our comparisons.
+ var checked = $checkbox.attr("data-checked");
+
+ if (checked === "0") {
+ $checkbox.attr("data-checked", "1");
+ $checkbox.html("☒");
+ return true;
+
+ } else {
+ $checkbox.attr("data-checked", "0");
+ $checkbox.html("☐");
+ return false;
+ }
+ }
+
+ $el.find(".split-horizontal")
+ .on("click", function() {
+ var checked = toggleCheckbox($(this).find(".options-checkbox"));
+ onOptionsChange("split", checked);
+ });
+
+ $el.find(".hide-internal")
+ .on("click", function() {
+ var checked = toggleCheckbox($(this).find(".options-checkbox"));
+ onOptionsChange("internals", checked);
+ });
+
+ $el.find(".hide-memory")
+ .on("click", function() {
+ var checked = toggleCheckbox($(this).find(".options-checkbox"));
+ onOptionsChange("memory", checked);
+ });
+
+ // Make the "hide internal" option available or unavailable to users
+ function enableHideInternal() {
+ $el.find(".hide-internal").css("display", "");
+ }
+ function disableHideInternal() {
+ $el.find(".hide-internal").css("display", "none");
+ }
+ // By default, start with it unavailable; it's only relevant for Shiny
+ // apps.
+ disableHideInternal();
+
+
+ $el.find(".hide-zero-row")
+ .on("click", function() {
+ var checked = toggleCheckbox($(this).find(".options-checkbox"));
+
+ if (checked) {
+ vis.codeTable.hideZeroTimeRows();
+ } else {
+ vis.codeTable.showZeroTimeRows();
+ }
+ });
+
+ el.style.visibility = "hidden";
+ function toggleVisibility(offset) {
+ if (el.style.visibility === "visible") {
+ el.style.visibility = "hidden";
+ } else {
+ el.style.visibility = "visible";
+ $(document).on("click", hideOnClickOutside);
+ }
+ }
+
+ // Hide the panel when a click happens outside. This handler also removes
+ // itself after it fires.
+ function hideOnClickOutside(e) {
+ var $el = $(el);
+ if (!$el.is(e.target) && $el.has(e.target).length === 0) {
+ el.style.visibility = "hidden";
+ // Unregister this event listener
+ $(document).off("click", hideOnClickOutside);
+ }
+ }
+
+ return {
+ el: el,
+ toggleVisibility: toggleVisibility,
+ enableHideInternal: enableHideInternal,
+ disableHideInternal: disableHideInternal
+ };
+ }
+
+ function notifySourceFileMessage(d, details) {
+ if (window.parent.postMessage) {
+ window.parent.postMessage({
+ source: "profvis",
+ message: "sourcefile",
+ file: d.filename,
+ normpath: d.normpath ? d.normpath : getNormPath(vis.files, d.filename),
+ line: d.linenum,
+ details: details
+ }, window.location.origin);
+ }
+ }
+
+ function roundOneDecimalNum(number, decimals) {
+ return Math.round(number * 10) / 10;
+ }
+
+ function roundOneDecimal(number, decimals) {
+ if (!number) return 0;
+ return roundOneDecimalNum(number).toFixed(1);
+ }
+
+ // Generate the code table ----------------------------------------
+ function generateCodeTable(el) {
+ var useMemory = false;
+ var content = d3.select(el);
+
+ if (vis.fileLineStats.length === 0) {
+ content.append("div")
+ .attr("class", "profvis-message")
+ .append("div")
+ .text("(Sources not available)");
+ }
+
+ // One table for each file
+ var tables = content.selectAll("table")
+ .data(vis.fileLineStats)
+ .enter()
+ .append("table")
+ .attr("class", "profvis-table");
+
+ // Table headers
+ var headerRows = tables.append("tr");
+ headerRows.append("th")
+ .attr("colspan", "2")
+ .attr("class", "filename")
+ .text(function(d) { return d.filename; });
+
+ var percentTooltip = "Percentage of tracked execution time";
+ var percentMemTooltip = "Percentage of peak memory deallocation and allocation";
+
+ headerRows.append("th")
+ .attr("class", "table-memory memory")
+ .attr("colspan", "4")
+ .text("Memory");
+
+ headerRows.append("th")
+ .attr("class", "time")
+ .attr("colspan", "2")
+ .text("Time");
+
+ headerRows.append("th")
+ .attr("class", "spacing")
+ .attr("data-pseudo-content", "\u00a0");
+
+ // Insert each line of code
+ var rows = tables.selectAll("tr.code-row")
+ .data(function(d) { return d.lineData; })
+ .enter()
+ .append("tr")
+ .attr("class", "code-row");
+
+ // Use pseudo-content and CSS content rule to make text unselectable and
+ // uncopyable. See https://danoc.me/blog/css-prevent-copy/
+ rows.append("td")
+ .attr("class", "linenum")
+ .attr("data-pseudo-content", function(d) { return d.linenum; });
+
+ rows.append("td")
+ .attr("class", "code r")
+ .text(function(d) { return d.content; })
+ .each(function() { hljs.highlightBlock(this); });
+
+ rows.append("td")
+ .attr("class", "table-memory memory")
+ .attr("title", "Memory deallocation (MB)")
+ .attr("data-pseudo-content",
+ function(d) { return roundOneDecimalNum(d.sumMemDealloc) !== 0 ? roundOneDecimal(d.sumMemDealloc) : ""; });
+
+ rows.append("td")
+ .attr("class", "table-memory membar-left-cell")
+ .append("div")
+ .attr("class", "membar")
+ .attr("title", percentMemTooltip)
+ .style("width", function(d) {
+ var p = Math.min(Math.abs(Math.min(Math.round(d.propMemDealloc * 100), 0)), 100);
+
+ // 8% is the minimal size that looks visually appealing while drawing an almost empty bar
+ p = roundOneDecimalNum(d.sumMemDealloc) !== 0 ? Math.max(p, 8) : 0;
+ return p + "%";
+ })
+ // Add the equivalent of to be added with CSS content
+ .attr("data-pseudo-content", "\u00a0");
+
+ rows.append("td")
+ .attr("class", "table-memory membar-right-cell")
+ .append("div")
+ .attr("class", "membar")
+ .attr("title", percentMemTooltip)
+ .style("width", function(d) {
+ var p = Math.min(Math.max(Math.round(d.propMemAlloc * 100), 0), 100);
+
+ // 4% is the minimal size that looks visually appealing while drawing an almost empty bar
+ p = roundOneDecimalNum(d.sumMemAlloc) !== 0 ? Math.max(p, 4) : 0;
+ return p + "%";
+ })
+ // Add the equivalent of to be added with CSS content
+ .attr("data-pseudo-content", "\u00a0");
+
+ rows.append("td")
+ .attr("class", "table-memory memory memory-right")
+ .attr("title", "Memory allocation (MB)")
+ .attr("data-pseudo-content",
+ function(d) { return roundOneDecimalNum(d.sumMemAlloc) !== 0 ? roundOneDecimal(d.sumMemAlloc) : ""; });
+
+ rows.append("td")
+ .attr("class", "time")
+ .attr("title", "Total time (ms)")
+ .attr("data-pseudo-content",
+ function(d) { return Math.round(d.sumTime * 100) !== 0 ? (Math.round(d.sumTime * 100) / 100) : ""; });
+
+ rows.append("td")
+ .attr("class", "timebar-cell")
+ .append("div")
+ .attr("class", "timebar")
+ .attr("title", percentTooltip)
+ .style("width", function(d) {
+ return Math.round(d.propTime * 100) + "%";
+ })
+ // Add the equivalent of to be added with CSS content
+ .attr("data-pseudo-content", "\u00a0");
+
+ rows.append("td")
+ .attr("class", "spacing")
+ .attr("data-pseudo-content", "\u00a0");
+
+ rows
+ .on("click", function(d) {
+ // Info box is only relevant when mousing over flamegraph
+ vis.infoBox.hide();
+ highlighter.click(d);
+ notifySourceFileMessage(d, "select");
+ })
+ .on("mouseover", function(d) {
+ if (highlighter.isLocked()) return;
+
+ // Info box is only relevant when mousing over flamegraph
+ vis.infoBox.hide();
+ highlighter.hover(d);
+ })
+ .on("mouseout", function(d) {
+ if (highlighter.isLocked()) return;
+
+ highlighter.hover(null);
+ })
+ .on("dblclick", function(d) {
+ notifySourceFileMessage(d, "open");
+ });
+
+ function hideZeroTimeRows() {
+ rows
+ .filter(function(d) { return d.sumTime === 0; })
+ .style("display", "none");
+ }
+
+ function showZeroTimeRows() {
+ rows
+ .filter(function(d) { return d.sumTime === 0; })
+ .style("display", "");
+ }
+
+ function addLockHighlight(d) {
+ var target = d;
+ rows
+ .filter(function(d) { return d === target; } )
+ .classed({ locked: true });
+ }
+
+ function clearLockHighlight() {
+ rows
+ .filter(".locked")
+ .classed({ locked: false });
+ }
+
+ function addActiveHighlight(d) {
+ // If we have filename and linenum, search for cells that match, and
+ // set them as "active".
+ var target = d;
+ if (target.filename && target.linenum) {
+ var tr = rows
+ .filter(function(d) {
+ return d.linenum === target.linenum &&
+ d.filename === target.filename;
+ })
+ .classed({ active: true });
+
+ tr.node().scrollIntoViewIfNeeded();
+ }
+ }
+
+ function clearActiveHighlight() {
+ rows
+ .filter(".active")
+ .classed({ active: false });
+ }
+
+ function enableScroll() {
+ // TODO: implement this
+ }
+
+ function disableScroll() {
+ }
+
+ function useMemoryResults() {
+ d3.selectAll(".table-memory").style("display", vis.hideMemory ? "none" : "");
+ }
+
+ return {
+ el: el,
+ hideZeroTimeRows: hideZeroTimeRows,
+ showZeroTimeRows: showZeroTimeRows,
+ addLockHighlight: addLockHighlight,
+ clearLockHighlight: clearLockHighlight,
+ addActiveHighlight: addActiveHighlight,
+ clearActiveHighlight: clearActiveHighlight,
+ enableScroll: enableScroll,
+ disableScroll: disableScroll,
+ useMemoryResults: useMemoryResults
+ };
+ }
+
+
+ var highlighter = (function() {
+ // D3 data objects for the currently locked and active items
+ var lockItem = null;
+ var activeItem = null;
+
+ function isLocked() {
+ return lockItem !== null;
+ }
+
+ function currentLock() {
+ return lockItem;
+ }
+
+ function currentActive() {
+ return activeItem;
+ }
+
+
+ // This is called when a flamegraph cell or a line of code is clicked on.
+ // Clicks also should trigger hover events.
+ function click(d) {
+ // If d is null (background is clicked), or if locked and this click
+ // is on the currently locked selection, just unlock and return.
+ if (d === null || (lockItem && d === lockItem)) {
+ lockItem = null;
+ vis.flameGraph.clearLockHighlight();
+ vis.codeTable.clearLockHighlight();
+ return;
+ }
+
+ // If nothing currently locked, or if locked and this click is on
+ // something other than the currently locked selection, then lock the
+ // current selection.
+ lockItem = d;
+
+ vis.flameGraph.clearLockHighlight();
+ vis.codeTable.clearLockHighlight();
+ hover(null);
+
+ vis.flameGraph.addLockHighlight(d);
+ vis.codeTable.addLockHighlight(d);
+ hover(d);
+ }
+
+
+ function hover(d) {
+ activeItem = d;
+
+ if (activeItem) {
+ vis.flameGraph.addActiveHighlight(activeItem);
+ vis.codeTable.addActiveHighlight(activeItem);
+ return;
+ }
+
+ vis.flameGraph.clearActiveHighlight();
+ vis.codeTable.clearActiveHighlight();
+ }
+
+ return {
+ isLocked: isLocked,
+ currentLock: currentLock,
+ currentActive: currentActive,
+
+ click: click,
+ hover: hover
+ };
+ })();
+
+
+ // Generate the flame graph -----------------------------------------------
+ function generateFlameGraph(el) {
+ el.innerHTML = "";
+
+ var stackHeight = 15; // Height of each layer on the stack, in pixels
+ var zoomMargin = 0.02; // Extra margin on sides when zooming to fit
+
+ // Dimensions -----------------------------------------------------------
+
+ // Margin inside the svg where the plotting occurs
+ var dims = {
+ margin: { top: 0, right: 0, left: 0, bottom: 30 }
+ };
+ dims.width = el.clientWidth - dims.margin.left - dims.margin.right;
+ dims.height = el.clientHeight - dims.margin.top - dims.margin.bottom;
+
+ var domains = {
+ x: [
+ d3.min(vis.prof, function(d) { return d.startTime; }),
+ d3.max(vis.prof, function(d) { return d.endTime; })
+ ],
+ y: [
+ d3.min(vis.prof, function(d) { return d.depth; }) - 1,
+ d3.max(vis.prof, function(d) { return d.depth; })
+ ]
+ };
+ // Slightly expand x domain
+ domains.x = expandRange(domains.x, zoomMargin);
+
+ // Scales ---------------------------------------------------------------
+ var scales = {
+ x: d3.scale.linear()
+ .domain(domains.x)
+ .range([0, dims.width]),
+
+ y: d3.scale.linear()
+ .domain(domains.y)
+ .range([dims.height, dims.height - (domains.y[1] - domains.y[0]) * stackHeight]),
+
+ // This will be a function that, given a data point, returns the depth.
+ // This function can change; sometimes it returns the original depth,
+ // and sometimes it returns the collapsed depth. This isn't exactly a
+ // scale function, but it's close enough for our purposes.
+ getDepth: null
+ };
+
+ function useCollapsedDepth() {
+ scales.getDepth = function(d) { return d.depthCollapsed; };
+ }
+ function useUncollapsedDepth() {
+ scales.getDepth = function(d) { return d.depth; };
+ }
+
+ useCollapsedDepth();
+
+ // SVG container objects ------------------------------------------------
+ var svg = d3.select(el).append('svg');
+
+ var clipRect = svg.append("clipPath")
+ .attr("id", "clip-" + vis.el.id)
+ .append("rect");
+
+ var container = svg.append('g')
+ .attr("transform", "translate(" + dims.margin.left + "," + dims.margin.top + ")")
+ .attr("clip-path", "url(" + urlNoHash() + "#clip-" + vis.el.id + ")");
+
+ // Add a background rect so we have something to grab for zooming/panning
+ var backgroundRect = container.append("rect")
+ .attr("class", "background");
+
+ // Axes ------------------------------------------------------------
+ var xAxis = d3.svg.axis()
+ .scale(scales.x)
+ .orient("bottom");
+
+ svg.append("g")
+ .attr("class", "x axis")
+ .call(xAxis);
+
+ // Container sizing -----------------------------------------------------
+ // Update dimensions of various container elements, based on the overall
+ // dimensions of the containing div.
+ function updateContainerSize() {
+ dims.width = el.clientWidth - dims.margin.left - dims.margin.right;
+ dims.height = el.clientHeight - dims.margin.top - dims.margin.bottom;
+
+ svg
+ .attr('width', dims.width + dims.margin.left + dims.margin.right)
+ .attr('height', dims.height + dims.margin.top + dims.margin.bottom);
+
+ clipRect
+ .attr("x", dims.margin.left)
+ .attr("y", dims.margin.top)
+ .attr("width", dims.width)
+ .attr("height", dims.height);
+
+ backgroundRect
+ .attr("width", dims.width)
+ .attr("height", dims.height);
+
+ svg.select(".x.axis")
+ .attr("transform", "translate(" + dims.margin.left + "," + dims.height + ")");
+ }
+
+
+ // Redrawing ------------------------------------------------------------
+
+ // Redrawing is a little complicated. For performance reasons, the
+ // flamegraph cells that are offscreen aren't rendered; they're removed
+ // from the D3 selection of cells. However, when transitions are
+ // involved, it may be necssary to add objects in their correct
+ // off-screen starting locations before the transition, and then do the
+ // transition. Similarly, it may be necssary to transition objects to
+ // their correct off-screen ending positions.
+ //
+ // In order to handle this, whenever there's a transition, we need to
+ // have the scales for before the transition, and after. When a function
+ // invokes a transition, it will generally do the following: (1) save the
+ // previous scales, (2) modify the current scales, (3) call a redraw
+ // function. The redraw functions are customized for different types of
+ // transitions, and they will use the saved previous scales to position
+ // objects correctly for the transition. When there's no transition, the
+ // previous scales aren't needed, and the redrawImmediate() function
+ // should be used.
+
+ // Cache cells for faster access (avoid a d3.select())
+ var cells;
+
+ // For a data element, return identifying key
+ function dataKey(d) {
+ return d.depth + "-" + d.startTime + "-" + d.endTime;
+ }
+
+ // For transitions with animation, we need to have a copy of the previous
+ // scales in addition to the current ones.
+ var prevScales = {};
+ function savePrevScales() {
+ prevScales = {
+ x: scales.x.copy(),
+ y: scales.y.copy(),
+ getDepth: scales.getDepth
+ };
+ }
+ savePrevScales();
+
+
+ // Returns a D3 selection of the cells that are within the plotting
+ // region, using a set of scales.
+ function selectActiveCells(scales) {
+ var xScale = scales.x;
+ var yScale = scales.y;
+ var depth = scales.getDepth;
+ var width = dims.width;
+ var height = dims.height;
+
+ var data = vis.prof.filter(function(d) {
+ var depthVal = depth(d);
+ return !(xScale(d.endTime) < 0 ||
+ xScale(d.startTime) > width ||
+ depthVal === null ||
+ yScale(depthVal - 1) < 0 ||
+ yScale(depthVal) > height);
+ });
+
+ cells = container.selectAll("g.cell").data(data, dataKey);
+
+ return cells;
+ }
+
+ // Given an enter selection, add the rect and text objects, but don't
+ // position them. Returns a selection of the new | Label | " + escapeHTML(label) + " |
| Called from | " + escapeHTML(ref) + " |
| Total time | " + (d.endTime - d.startTime) + "ms |
| Memory | " + + roundOneDecimal(d.sumMemDealloc) + " / " + roundOneDecimal(d.sumMemAlloc) + + " MB |
| Agg. total time | " + vis.aggLabelTimes[label] + "ms |
| Call stack depth | " + d.depth + " |
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/authors.html b/docs/authors.html
index 2a5a54d..153bb93 100644
--- a/docs/authors.html
+++ b/docs/authors.html
@@ -1,71 +1,12 @@
-
-
-
-
-
-
-
-
+
+
- Articles
@@ -131,30 +57,27 @@Articles
All vignettes
- -
-
-
+
-
-
-
+
`, then `
-
+
+
-
-
-
+
diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css
new file mode 100644
index 0000000..5a85941
--- /dev/null
+++ b/docs/bootstrap-toc.css
@@ -0,0 +1,60 @@
+/*!
+ * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/)
+ * Copyright 2015 Aidan Feldman
+ * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */
+
+/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */
+
+/* All levels of nav */
+nav[data-toggle='toc'] .nav > li > a {
+ display: block;
+ padding: 4px 20px;
+ font-size: 13px;
+ font-weight: 500;
+ color: #767676;
+}
+nav[data-toggle='toc'] .nav > li > a:hover,
+nav[data-toggle='toc'] .nav > li > a:focus {
+ padding-left: 19px;
+ color: #563d7c;
+ text-decoration: none;
+ background-color: transparent;
+ border-left: 1px solid #563d7c;
+}
+nav[data-toggle='toc'] .nav > .active > a,
+nav[data-toggle='toc'] .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav > .active:focus > a {
+ padding-left: 18px;
+ font-weight: bold;
+ color: #563d7c;
+ background-color: transparent;
+ border-left: 2px solid #563d7c;
+}
+
+/* Nav: second level (shown on .active) */
+nav[data-toggle='toc'] .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+nav[data-toggle='toc'] .nav .nav > li > a {
+ padding-top: 1px;
+ padding-bottom: 1px;
+ padding-left: 30px;
+ font-size: 12px;
+ font-weight: normal;
+}
+nav[data-toggle='toc'] .nav .nav > li > a:hover,
+nav[data-toggle='toc'] .nav .nav > li > a:focus {
+ padding-left: 29px;
+}
+nav[data-toggle='toc'] .nav .nav > .active > a,
+nav[data-toggle='toc'] .nav .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav .nav > .active:focus > a {
+ padding-left: 28px;
+ font-weight: 500;
+}
+
+/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */
+nav[data-toggle='toc'] .nav > .active > ul {
+ display: block;
+}
diff --git a/docs/bootstrap-toc.js b/docs/bootstrap-toc.js
new file mode 100644
index 0000000..1cdd573
--- /dev/null
+++ b/docs/bootstrap-toc.js
@@ -0,0 +1,159 @@
+/*!
+ * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/)
+ * Copyright 2015 Aidan Feldman
+ * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */
+(function() {
+ 'use strict';
+
+ window.Toc = {
+ helpers: {
+ // return all matching elements in the set, or their descendants
+ findOrFilter: function($el, selector) {
+ // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/
+ // http://stackoverflow.com/a/12731439/358804
+ var $descendants = $el.find(selector);
+ return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])');
+ },
+
+ generateUniqueIdBase: function(el) {
+ var text = $(el).text();
+ var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-');
+ return anchor || el.tagName.toLowerCase();
+ },
+
+ generateUniqueId: function(el) {
+ var anchorBase = this.generateUniqueIdBase(el);
+ for (var i = 0; ; i++) {
+ var anchor = anchorBase;
+ if (i > 0) {
+ // add suffix
+ anchor += '-' + i;
+ }
+ // check if ID already exists
+ if (!document.getElementById(anchor)) {
+ return anchor;
+ }
+ }
+ },
+
+ generateAnchor: function(el) {
+ if (el.id) {
+ return el.id;
+ } else {
+ var anchor = this.generateUniqueId(el);
+ el.id = anchor;
+ return anchor;
+ }
+ },
+
+ createNavList: function() {
+ return $('');
+ },
+
+ createChildNavList: function($parent) {
+ var $childList = this.createNavList();
+ $parent.append($childList);
+ return $childList;
+ },
+
+ generateNavEl: function(anchor, text) {
+ var $a = $('');
+ $a.attr('href', '#' + anchor);
+ $a.text(text);
+ var $li = $('');
+ $li.append($a);
+ return $li;
+ },
+
+ generateNavItem: function(headingEl) {
+ var anchor = this.generateAnchor(headingEl);
+ var $heading = $(headingEl);
+ var text = $heading.data('toc-text') || $heading.text();
+ return this.generateNavEl(anchor, text);
+ },
+
+ // Find the first heading level (`
-
@@ -140,22 +86,20 @@ Authors
+ +
+
-
+
Citation
+ Source:DESCRIPTION
+ -
-
-
-
Tian-Yuan Huang. Author, maintainer.
-
-
-
Huang T (2024). +tidyft: Fast and Memory Efficient Data Operations in Tidy Syntax. +R package version 0.9.20, https://hope-data-science.github.io/tidyft/, https://github.com/hope-data-science/tidyft. +
+@Manual{,
+ title = {tidyft: Fast and Memory Efficient Data Operations in Tidy Syntax},
+ author = {Tian-Yuan Huang},
+ year = {2024},
+ note = {R package version 0.9.20, https://hope-data-science.github.io/tidyft/},
+ url = {https://github.com/hope-data-science/tidyft},
+}
Authors
-`, then ``, etc.) that has more than one element. Defaults to 1 (for ``).
+ getTopLevel: function($scope) {
+ for (var i = 1; i <= 6; i++) {
+ var $headings = this.findOrFilter($scope, 'h' + i);
+ if ($headings.length > 1) {
+ return i;
+ }
+ }
+
+ return 1;
+ },
+
+ // returns the elements for the top level, and the next below it
+ getHeadings: function($scope, topLevel) {
+ var topSelector = 'h' + topLevel;
+
+ var secondaryLevel = topLevel + 1;
+ var secondarySelector = 'h' + secondaryLevel;
+
+ return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
+ },
+
+ getNavLevel: function(el) {
+ return parseInt(el.tagName.charAt(1), 10);
+ },
+
+ populateNav: function($topContext, topLevel, $headings) {
+ var $context = $topContext;
+ var $prevNav;
+
+ var helpers = this;
+ $headings.each(function(i, el) {
+ var $newNav = helpers.generateNavItem(el);
+ var navLevel = helpers.getNavLevel(el);
+
+ // determine the proper $context
+ if (navLevel === topLevel) {
+ // use top level
+ $context = $topContext;
+ } else if ($prevNav && $context === $topContext) {
+ // create a new level of the tree and switch to it
+ $context = helpers.createChildNavList($prevNav);
+ } // else use the current $context
+
+ $context.append($newNav);
+
+ $prevNav = $newNav;
+ });
+ },
+
+ parseOps: function(arg) {
+ var opts;
+ if (arg.jquery) {
+ opts = {
+ $nav: arg
+ };
+ } else {
+ opts = arg;
+ }
+ opts.$scope = opts.$scope || $(document.body);
+ return opts;
+ }
+ },
+
+ // accepts a jQuery object, or an options object
+ init: function(opts) {
+ opts = this.helpers.parseOps(opts);
+
+ // ensure that the data attribute is in place for styling
+ opts.$nav.attr('data-toggle', 'toc');
+
+ var $topContext = this.helpers.createChildNavList(opts.$nav);
+ var topLevel = this.helpers.getTopLevel(opts.$scope);
+ var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
+ this.helpers.populateNav($topContext, topLevel, $headings);
+ }
+ };
+
+ $(function() {
+ $('nav[data-toggle="toc"]').each(function(i, el) {
+ var $nav = $(el);
+ Toc.init($nav);
+ });
+ });
+})();
diff --git a/docs/index.html b/docs/index.html
index c4f228a..c0f4417 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -5,241 +5,243 @@
-Tidy Verbs for Fast Data Operations by Reference • tidyft
+Fast and Memory Efficient Data Operations in Tidy Syntax • tidyft
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-Overview
-tidyft is an extension of data.table. Using modification by reference whenever possible, this toolkit is designed for big data analysis in high-performance desktop or laptop computers. The syntax of the package is similar or identical to tidyverse. It is user friendly, memory efficient and time saving. For more information, check its ancestor package tidyfst.
-This design is best for big data manipulation on out of memory data using facilities provided by fst. In such ways, you can handle the most quantity of data in the least time and space on your computer.
-
-
-
-
-Example
-This is a basic example which shows you how to solve a common problem:
-library(tidyft)
-
-# get first 5 rows of iris
-as.data.table(iris)[1:5] -> a
-#show
-a
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.9 3.0 1.4 0.2 setosa
-#> 3: 4.7 3.2 1.3 0.2 setosa
-#> 4: 4.6 3.1 1.5 0.2 setosa
-#> 5: 5.0 3.6 1.4 0.2 setosa
-
-# if you select
-a %>% select(1:3)
-#> Sepal.Length Sepal.Width Petal.Length
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4
-
-# you lose the unselected columns forever
-a
-#> Sepal.Length Sepal.Width Petal.Length
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4
-If you still want to keep the original data, use copy() to make a copy beforehand.
-
-
-
-Tutorial
-See vignettes.
-
-
-
-Performance
-
-
-rm(list = ls())
-
-library(profvis)
-library(dplyr)
-library(tidyft)
-as.data.frame(starwars) -> starwars
-starwars[sample.int(1:nrow(starwars),1e6,replace = T),] -> starwars
-copy(starwars) -> dat1
-copy(starwars) -> dat2
-copy(starwars) -> dat3
-
-profvis({
- dat1 %>%
- dplyr::as_tibble() %>%
- dplyr::select(name, dplyr::ends_with("color")) %>%
- dplyr::arrange(hair_color,skin_color,eye_color) -> a
-
- setorder(setDT(dat2)[,.SD,.SDcols = patterns("name|color$")],
- hair_color,skin_color,eye_color) -> b
-
- dat3 %>%
- tidyft::setDT() %>%
- tidyft::select("name|color$") %>%
- tidyft::arrange(hair_color,skin_color,eye_color) -> c
-
-
-})
-
-all.equal(a,b)
-#> [1] TRUE
-all.equal(b,c)
-#> [1] TRUE
-
-
-
-
-
-
-
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
diff --git a/docs/pkgdown.css b/docs/pkgdown.css
index 9145958..80ea5b8 100644
--- a/docs/pkgdown.css
+++ b/docs/pkgdown.css
@@ -17,6 +17,10 @@ html, body {
height: 100%;
}
+body {
+ position: relative;
+}
+
body > .container {
display: flex;
height: 100%;
@@ -52,8 +56,10 @@ img.icon {
float: right;
}
-img {
+/* Ensure in-page images don't run outside their container */
+.contents img {
max-width: 100%;
+ height: auto;
}
/* Fix bug in bootstrap (only seen in firefox) */
@@ -67,14 +73,17 @@ summary {
margin-top: calc(-60px + 1em);
}
+dd {
+ margin-left: 3em;
+}
+
/* Section anchors ---------------------------------*/
a.anchor {
- margin-left: -30px;
- display:inline-block;
- width: 30px;
- height: 30px;
- visibility: hidden;
+ display: none;
+ margin-left: 5px;
+ width: 20px;
+ height: 20px;
background-image: url(./link.svg);
background-repeat: no-repeat;
@@ -82,17 +91,15 @@ a.anchor {
background-position: center center;
}
-.hasAnchor:hover a.anchor {
- visibility: visible;
+h1:hover .anchor,
+h2:hover .anchor,
+h3:hover .anchor,
+h4:hover .anchor,
+h5:hover .anchor,
+h6:hover .anchor {
+ display: inline-block;
}
-@media (max-width: 767px) {
- .hasAnchor:hover a.anchor {
- visibility: hidden;
- }
-}
-
-
/* Fixes for fixed navbar --------------------------*/
.contents h1, .contents h2, .contents h3, .contents h4 {
@@ -100,29 +107,132 @@ a.anchor {
margin-top: -40px;
}
+/* Navbar submenu --------------------------*/
+
+.dropdown-submenu {
+ position: relative;
+}
+
+.dropdown-submenu>.dropdown-menu {
+ top: 0;
+ left: 100%;
+ margin-top: -6px;
+ margin-left: -1px;
+ border-radius: 0 6px 6px 6px;
+}
+
+.dropdown-submenu:hover>.dropdown-menu {
+ display: block;
+}
+
+.dropdown-submenu>a:after {
+ display: block;
+ content: " ";
+ float: right;
+ width: 0;
+ height: 0;
+ border-color: transparent;
+ border-style: solid;
+ border-width: 5px 0 5px 5px;
+ border-left-color: #cccccc;
+ margin-top: 5px;
+ margin-right: -10px;
+}
+
+.dropdown-submenu:hover>a:after {
+ border-left-color: #ffffff;
+}
+
+.dropdown-submenu.pull-left {
+ float: none;
+}
+
+.dropdown-submenu.pull-left>.dropdown-menu {
+ left: -100%;
+ margin-left: 10px;
+ border-radius: 6px 0 6px 6px;
+}
+
/* Sidebar --------------------------*/
-#sidebar {
+#pkgdown-sidebar {
margin-top: 30px;
position: -webkit-sticky;
position: sticky;
top: 70px;
}
-#sidebar h2 {
+
+#pkgdown-sidebar h2 {
font-size: 1.5em;
margin-top: 1em;
}
-#sidebar h2:first-child {
+#pkgdown-sidebar h2:first-child {
margin-top: 0;
}
-#sidebar .list-unstyled li {
+#pkgdown-sidebar .list-unstyled li {
margin-bottom: 0.5em;
}
+/* bootstrap-toc tweaks ------------------------------------------------------*/
+
+/* All levels of nav */
+
+nav[data-toggle='toc'] .nav > li > a {
+ padding: 4px 20px 4px 6px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+}
+
+nav[data-toggle='toc'] .nav > li > a:hover,
+nav[data-toggle='toc'] .nav > li > a:focus {
+ padding-left: 5px;
+ color: inherit;
+ border-left: 1px solid #878787;
+}
+
+nav[data-toggle='toc'] .nav > .active > a,
+nav[data-toggle='toc'] .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav > .active:focus > a {
+ padding-left: 5px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+ border-left: 2px solid #878787;
+}
+
+/* Nav: second level (shown on .active) */
+
+nav[data-toggle='toc'] .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a {
+ padding-left: 16px;
+ font-size: 1.35rem;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a:hover,
+nav[data-toggle='toc'] .nav .nav > li > a:focus {
+ padding-left: 15px;
+}
+
+nav[data-toggle='toc'] .nav .nav > .active > a,
+nav[data-toggle='toc'] .nav .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav .nav > .active:focus > a {
+ padding-left: 15px;
+ font-weight: 500;
+ font-size: 1.35rem;
+}
+
+/* orcid ------------------------------------------------------------------- */
+
.orcid {
- height: 16px;
+ font-size: 16px;
+ color: #A6CE39;
/* margins are required by official ORCID trademark and display guidelines */
margin-left:4px;
margin-right:4px;
@@ -133,14 +243,14 @@ a.anchor {
.ref-index th {font-weight: normal;}
-.ref-index td {vertical-align: top;}
+.ref-index td {vertical-align: top; min-width: 100px}
.ref-index .icon {width: 40px;}
.ref-index .alias {width: 40%;}
.ref-index-icons .alias {width: calc(40% - 40px);}
.ref-index .title {width: 60%;}
.ref-arguments th {text-align: right; padding-right: 10px;}
-.ref-arguments th, .ref-arguments td {vertical-align: top;}
+.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
.ref-arguments .name {width: 20%;}
.ref-arguments .desc {width: 80%;}
@@ -153,31 +263,26 @@ table {
/* Syntax highlighting ---------------------------------------------------- */
-pre {
- word-wrap: normal;
- word-break: normal;
- border: 1px solid #eee;
-}
-
-pre, code {
+pre, code, pre code {
background-color: #f8f8f8;
color: #333;
}
+pre, pre code {
+ white-space: pre-wrap;
+ word-break: break-all;
+ overflow-wrap: break-word;
+}
-pre code {
- overflow: auto;
- word-wrap: normal;
- white-space: pre;
+pre {
+ border: 1px solid #eee;
}
-pre .img {
+pre .img, pre .r-plt {
margin: 5px 0;
}
-pre .img img {
+pre .img img, pre .r-plt img {
background-color: #fff;
- display: block;
- height: auto;
}
code a, pre a {
@@ -194,9 +299,8 @@ a.sourceLine:hover {
.kw {color: #264D66;} /* keyword */
.co {color: #888888;} /* comment */
-.message { color: black; font-weight: bolder;}
-.error { color: orange; font-weight: bolder;}
-.warning { color: #6A0366; font-weight: bolder;}
+.error {font-weight: bolder;}
+.warning {font-weight: bolder;}
/* Clipboard --------------------------*/
@@ -254,3 +358,27 @@ mark {
content: "";
}
}
+
+/* Section anchors ---------------------------------
+ Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
+*/
+
+div.csl-bib-body { }
+div.csl-entry {
+ clear: both;
+}
+.hanging-indent div.csl-entry {
+ margin-left:2em;
+ text-indent:-2em;
+}
+div.csl-left-margin {
+ min-width:2em;
+ float:left;
+}
+div.csl-right-inline {
+ margin-left:2em;
+ padding-left:1em;
+}
+div.csl-indent {
+ margin-left: 2em;
+}
diff --git a/docs/pkgdown.js b/docs/pkgdown.js
index 087a762..6f0eee4 100644
--- a/docs/pkgdown.js
+++ b/docs/pkgdown.js
@@ -9,11 +9,6 @@
$('body').css('padding-top', $('.navbar').height() + 10);
});
- $('body').scrollspy({
- target: '#sidebar',
- offset: 60
- });
-
$('[data-toggle="tooltip"]').tooltip();
var cur_path = paths(location.pathname);
@@ -85,7 +80,7 @@
$(document).ready(function() {
var copyButton = "";
- $(".examples, div.sourceCode").addClass("hasCopyButton");
+ $("div.sourceCode").addClass("hasCopyButton");
// Insert copy buttons:
$(copyButton).prependTo(".hasCopyButton");
@@ -96,7 +91,7 @@
// Initialize clipboard:
var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', {
text: function(trigger) {
- return trigger.parentNode.textContent;
+ return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, "");
}
});
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index e93a3fb..eb9bb62 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -1,6 +1,6 @@
-pandoc: 2.7.2
-pkgdown: 1.4.1
+pandoc: 3.1.11
+pkgdown: 2.1.0
pkgdown_sha: ~
articles:
Introduction: Introduction.html
-
+last_built: 2024-09-22T01:35Z
diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png
new file mode 100644
index 0000000000000000000000000000000000000000..17a358060aed2a86950757bbd25c6f92c08c458f
GIT binary patch
literal 1011
zcmeAS@N?(olHy`uVBq!ia0y~yV0-|=9Be?5+AI5}0x7m6Z+90U4Fo@(ch>_c&H|6f
zVg?3oArNM~bhqvg0|WD9PZ!6KiaBo&GBN^{G%5UFpXcEKVvd5*5Eu=C0SJK)8A6*F
U7`aXvEC5;V>FVdQ&MBb@00SN#Z2$lO
literal 0
HcmV?d00001
diff --git a/docs/reference/arrange.html b/docs/reference/arrange.html
index 004dadc..ec794b1 100644
--- a/docs/reference/arrange.html
+++ b/docs/reference/arrange.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Arrange entries in data.frame — arrange • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Arrange entries in data.frame — arrange • tidyft
-
-
+
-
-
-
-
-
-
-
+
@@ -134,128 +59,132 @@ Arrange entries in data.frame
Analogous function for arrange in dplyr.
- arrange(.data, ..., cols = NULL, order = 1L)
-
- Arguments
-
-
- .data
- data.frame
-
- ...
- Arrange by what group? Minus symbol means arrange by
-descending order.
-
- cols
- For set_arrange only.
+
+ arrange(.data, ..., cols = NULL, order = 1L)
+
+
+
-
- order
- For set_arrange only. An integer vector with only possible
-values of 1 and -1, corresponding to ascending and descending order.
-Defaults to 1.
-
+If present, override .... Defaults to NULL.
- Value
- A data.table
- Details
+order
+For set_arrange only. An integer vector with only possible
+values of 1 and -1, corresponding to ascending and descending order.
+Defaults to 1.
Value
+ A data.table
+
+
+ Details
Once arranged, the order of entries would be changed forever.
- See also
-
-
-
- Examples
- #> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 4.3 3.0 1.1 0.1 setosa
-#> 2: 4.4 2.9 1.4 0.2 setosa
-#> 3: 4.4 3.0 1.3 0.2 setosa
-#> 4: 4.4 3.2 1.3 0.2 setosa
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 7.7 3.8 6.7 2.2 virginica
-#> 147: 7.7 2.6 6.9 2.3 virginica
-#> 148: 7.7 2.8 6.7 2.0 virginica
-#> 149: 7.7 3.0 6.1 2.3 virginica
-#> 150: 7.9 3.8 6.4 2.0 virginicaa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 4.3 3.0 1.1 0.1 setosa
-#> 2: 4.4 2.9 1.4 0.2 setosa
-#> 3: 4.4 3.0 1.3 0.2 setosa
-#> 4: 4.4 3.2 1.3 0.2 setosa
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 7.7 3.8 6.7 2.2 virginica
-#> 147: 7.7 2.6 6.9 2.3 virginica
-#> 148: 7.7 2.8 6.7 2.0 virginica
-#> 149: 7.7 3.0 6.1 2.3 virginica
-#> 150: 7.9 3.8 6.4 2.0 virginica#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.0 2.0 3.5 1.0 versicolor
-#> 2: 6.0 2.2 4.0 1.0 versicolor
-#> 3: 6.2 2.2 4.5 1.5 versicolor
-#> 4: 6.0 2.2 5.0 1.5 virginica
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 5.4 3.9 1.7 0.4 setosa
-#> 147: 5.8 4.0 1.2 0.2 setosa
-#> 148: 5.2 4.1 1.5 0.1 setosa
-#> 149: 5.5 4.2 1.4 0.2 setosa
-#> 150: 5.7 4.4 1.5 0.4 setosaa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.0 2.0 3.5 1.0 versicolor
-#> 2: 6.0 2.2 4.0 1.0 versicolor
-#> 3: 6.2 2.2 4.5 1.5 versicolor
-#> 4: 6.0 2.2 5.0 1.5 virginica
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 5.4 3.9 1.7 0.4 setosa
-#> 147: 5.8 4.0 1.2 0.2 setosa
-#> 148: 5.2 4.1 1.5 0.1 setosa
-#> 149: 5.5 4.2 1.4 0.2 setosa
-#> 150: 5.7 4.4 1.5 0.4 setosa
-
-
-
+
+
+ Examples
+
+a = as.data.table(iris)
+a %>% arrange(Sepal.Length)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 4.3 3.0 1.1 0.1 setosa
+#> 2: 4.4 2.9 1.4 0.2 setosa
+#> 3: 4.4 3.0 1.3 0.2 setosa
+#> 4: 4.4 3.2 1.3 0.2 setosa
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 7.7 3.8 6.7 2.2 virginica
+#> 147: 7.7 2.6 6.9 2.3 virginica
+#> 148: 7.7 2.8 6.7 2.0 virginica
+#> 149: 7.7 3.0 6.1 2.3 virginica
+#> 150: 7.9 3.8 6.4 2.0 virginica
+a
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 4.3 3.0 1.1 0.1 setosa
+#> 2: 4.4 2.9 1.4 0.2 setosa
+#> 3: 4.4 3.0 1.3 0.2 setosa
+#> 4: 4.4 3.2 1.3 0.2 setosa
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 7.7 3.8 6.7 2.2 virginica
+#> 147: 7.7 2.6 6.9 2.3 virginica
+#> 148: 7.7 2.8 6.7 2.0 virginica
+#> 149: 7.7 3.0 6.1 2.3 virginica
+#> 150: 7.9 3.8 6.4 2.0 virginica
+a %>% arrange(cols = c("Sepal.Width","Petal.Length"))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.0 2.0 3.5 1.0 versicolor
+#> 2: 6.0 2.2 4.0 1.0 versicolor
+#> 3: 6.2 2.2 4.5 1.5 versicolor
+#> 4: 6.0 2.2 5.0 1.5 virginica
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 5.4 3.9 1.7 0.4 setosa
+#> 147: 5.8 4.0 1.2 0.2 setosa
+#> 148: 5.2 4.1 1.5 0.1 setosa
+#> 149: 5.5 4.2 1.4 0.2 setosa
+#> 150: 5.7 4.4 1.5 0.4 setosa
+a
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.0 2.0 3.5 1.0 versicolor
+#> 2: 6.0 2.2 4.0 1.0 versicolor
+#> 3: 6.2 2.2 4.5 1.5 versicolor
+#> 4: 6.0 2.2 5.0 1.5 virginica
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 5.4 3.9 1.7 0.4 setosa
+#> 147: 5.8 4.0 1.2 0.2 setosa
+#> 148: 5.2 4.1 1.5 0.1 setosa
+#> 149: 5.5 4.2 1.4 0.2 setosa
+#> 150: 5.7 4.4 1.5 0.4 setosa
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/as_fst.html b/docs/reference/as_fst.html
index 300e5ec..c5acdd9 100644
--- a/docs/reference/as_fst.html
+++ b/docs/reference/as_fst.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Save a data.frame as a fst table — as_fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Save a data.frame as a fst table — as_fst • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -136,72 +61,70 @@ Save a data.frame as a fst table
and then parse it back as a fst table (class name is "fst_table").
- as_fst(.data)
+
+ as_fst(.data)
+
- Arguments
-
-
- .data
- A data.frame
-
+
+ Arguments
- Value
- An object of class fst_table
+- .data
+A data.frame
Examples
-
-# \donttest{
- iris %>%
- as_fst() -> iris_fst
- iris_fst#> <fst file>
-#> 150 rows, 5 columns (.a5445415a58.fst)
-#>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <double> <double> <double> <double> <factor>
-#> 1 5.1 3.5 1.4 0.2 setosa
-#> 2 4.9 3.0 1.4 0.2 setosa
-#> 3 4.7 3.2 1.3 0.2 setosa
-#> 4 4.6 3.1 1.5 0.2 setosa
-#> 5 5.0 3.6 1.4 0.2 setosa
-#> -- -- -- -- -- --
-#> 146 6.7 3.0 5.2 2.3 virginica
-#> 147 6.3 2.5 5.0 1.9 virginica
-#> 148 6.5 3.0 5.2 2.0 virginica
-#> 149 6.2 3.4 5.4 2.3 virginica
-#> 150 5.9 3.0 5.1 1.8 virginica# }
-
-
-
+
+ Value
+ An object of class fst_table
+
+
+ Examples
+
+# \donttest{
+ iris %>%
+ as_fst() -> iris_fst
+ iris_fst
+#> <fst file>
+#> 150 rows, 5 columns (.27606c92540e.fst)
+#>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <double> <double> <double> <double> <factor>
+#> 1 5.1 3.5 1.4 0.2 setosa
+#> 2 4.9 3.0 1.4 0.2 setosa
+#> 3 4.7 3.2 1.3 0.2 setosa
+#> 4 4.6 3.1 1.5 0.2 setosa
+#> 5 5.0 3.6 1.4 0.2 setosa
+#> -- -- -- -- -- --
+#> 146 6.7 3.0 5.2 2.3 virginica
+#> 147 6.3 2.5 5.0 1.9 virginica
+#> 148 6.5 3.0 5.2 2.0 virginica
+#> 149 6.2 3.4 5.4 2.3 virginica
+#> 150 5.9 3.0 5.1 1.8 virginica
+# }
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/complete.html b/docs/reference/complete.html
index 2dce3ea..0d9cfee 100644
--- a/docs/reference/complete.html
+++ b/docs/reference/complete.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Complete a data frame with missing combinations of data — complete • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Complete a data frame with missing combinations of data — complete • tidyft
-
+
-
-
-
-
-
-
-
-
+
Complete a data frame with missing combinations of data
- Source: R/complete.R
+ Source: R/complete.R
complete.Rd
@@ -136,150 +61,158 @@ Complete a data frame with missing combinations of data
Analogous function for complete function in tidyr.
- complete(.data, ..., fill = NA)
+
+ complete(.data, ..., fill = NA)
+
+
+
+ Arguments
- Arguments
-
-
- .data
- data.frame
-
- ...
- Specification of columns to expand.The selection of columns is
-supported by the flexible select_dt.
+
+
- .data
+data.frame
- ...
+Specification of columns to expand.The selection of columns is
+supported by the flexible select_dt.
To find all unique combinations of provided columns, including those not found in the data,
supply each variable as a separate argument. But the two modes (select the
needed columns and fill outside values) could not be mixed,
-find more details in examples.
-
- fill
- Atomic value to fill into the missing cell, default uses NA.
-
+find more details in examples.
- Value
- data.table
- Details
+fill
+Atomic value to fill into the missing cell, default uses NA.
Value
+ data.table
+
+
+ Details
When the provided columns with addtion data are of different length,
all the unique combinations would be returned. This operation should be used
only on unique entries, and it will always returned the unique entries.
If you supply fill parameter, these values will also replace existing explicit missing values in the data set.
- See also
-
-
-
- Examples
- df <- data.table(
- group = c(1:2, 1),
- item_id = c(1:2, 2),
- item_name = c("a", "b", "b"),
- value1 = 1:3,
- value2 = 4:6
-)
-
-df %>% complete(item_id,item_name)#> Key: <item_id, item_name>
-#> item_id item_name group value1 value2
-#> <num> <char> <num> <int> <int>
-#> 1: 1 a 1 1 4
-#> 2: 1 b NA NA NA
-#> 3: 2 a NA NA NA
-#> 4: 2 b 2 2 5
-#> 5: 2 b 1 3 6df %>% complete(item_id,item_name,fill = 0)#> Key: <item_id, item_name>
-#> item_id item_name group value1 value2
-#> <num> <char> <num> <int> <int>
-#> 1: 1 a 1 1 4
-#> 2: 1 b 0 0 0
-#> 3: 2 a 0 0 0
-#> 4: 2 b 2 2 5
-#> 5: 2 b 1 3 6df %>% complete("item")#> Key: <item_id, item_name>
-#> item_id item_name group value1 value2
-#> <num> <char> <num> <int> <int>
-#> 1: 1 a 1 1 4
-#> 2: 1 b NA NA NA
-#> 3: 2 a NA NA NA
-#> 4: 2 b 2 2 5
-#> 5: 2 b 1 3 6df %>% complete(item_id=1:3)#> Key: <item_id>
-#> item_id group item_name value1 value2
-#> <int> <num> <char> <int> <int>
-#> 1: 1 1 a 1 4
-#> 2: 2 2 b 2 5
-#> 3: 2 1 b 3 6
-#> 4: 3 NA <NA> NA NAdf %>% complete(item_id=1:3,group=1:2)#> Key: <item_id, group>
-#> item_id group item_name value1 value2
-#> <int> <int> <char> <int> <int>
-#> 1: 1 1 a 1 4
-#> 2: 1 2 <NA> NA NA
-#> 3: 2 1 b 3 6
-#> 4: 2 2 b 2 5
-#> 5: 3 1 <NA> NA NA
-#> 6: 3 2 <NA> NA NA#> Key: <item_id, group, item_name>
-#> item_id group item_name value1 value2
-#> <int> <int> <char> <int> <int>
-#> 1: 1 1 a 1 4
-#> 2: 1 1 b NA NA
-#> 3: 1 1 c NA NA
-#> 4: 1 2 a NA NA
-#> 5: 1 2 b NA NA
-#> 6: 1 2 c NA NA
-#> 7: 1 3 a NA NA
-#> 8: 1 3 b NA NA
-#> 9: 1 3 c NA NA
-#> 10: 2 1 a NA NA
-#> 11: 2 1 b 3 6
-#> 12: 2 1 c NA NA
-#> 13: 2 2 a NA NA
-#> 14: 2 2 b 2 5
-#> 15: 2 2 c NA NA
-#> 16: 2 3 a NA NA
-#> 17: 2 3 b NA NA
-#> 18: 2 3 c NA NA
-#> 19: 3 1 a NA NA
-#> 20: 3 1 b NA NA
-#> 21: 3 1 c NA NA
-#> 22: 3 2 a NA NA
-#> 23: 3 2 b NA NA
-#> 24: 3 2 c NA NA
-#> 25: 3 3 a NA NA
-#> 26: 3 3 b NA NA
-#> 27: 3 3 c NA NA
-#> item_id group item_name value1 value2
-
-
-
+
+ See also
+
+
+
+ Examples
+ df <- data.table(
+ group = c(1:2, 1),
+ item_id = c(1:2, 2),
+ item_name = c("a", "b", "b"),
+ value1 = 1:3,
+ value2 = 4:6
+)
+
+df %>% complete(item_id,item_name)
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b NA NA NA
+#> 3: 2 a NA NA NA
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete(item_id,item_name,fill = 0)
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b 0 0 0
+#> 3: 2 a 0 0 0
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete("item")
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b NA NA NA
+#> 3: 2 a NA NA NA
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete(item_id=1:3)
+#> Key: <item_id>
+#> item_id group item_name value1 value2
+#> <int> <num> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 2 2 b 2 5
+#> 3: 2 1 b 3 6
+#> 4: 3 NA <NA> NA NA
+df %>% complete(item_id=1:3,group=1:2)
+#> Key: <item_id, group>
+#> item_id group item_name value1 value2
+#> <int> <int> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 1 2 <NA> NA NA
+#> 3: 2 1 b 3 6
+#> 4: 2 2 b 2 5
+#> 5: 3 1 <NA> NA NA
+#> 6: 3 2 <NA> NA NA
+df %>% complete(item_id=1:3,group=1:3,item_name=c("a","b","c"))
+#> Key: <item_id, group, item_name>
+#> item_id group item_name value1 value2
+#> <int> <int> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 1 1 b NA NA
+#> 3: 1 1 c NA NA
+#> 4: 1 2 a NA NA
+#> 5: 1 2 b NA NA
+#> 6: 1 2 c NA NA
+#> 7: 1 3 a NA NA
+#> 8: 1 3 b NA NA
+#> 9: 1 3 c NA NA
+#> 10: 2 1 a NA NA
+#> 11: 2 1 b 3 6
+#> 12: 2 1 c NA NA
+#> 13: 2 2 a NA NA
+#> 14: 2 2 b 2 5
+#> 15: 2 2 c NA NA
+#> 16: 2 3 a NA NA
+#> 17: 2 3 b NA NA
+#> 18: 2 3 c NA NA
+#> 19: 3 1 a NA NA
+#> 20: 3 1 b NA NA
+#> 21: 3 1 c NA NA
+#> 22: 3 2 a NA NA
+#> 23: 3 2 b NA NA
+#> 24: 3 2 c NA NA
+#> 25: 3 3 a NA NA
+#> 26: 3 3 b NA NA
+#> 27: 3 3 c NA NA
+#> item_id group item_name value1 value2
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/count.html b/docs/reference/count.html
index 895be5a..0f6fe7e 100644
--- a/docs/reference/count.html
+++ b/docs/reference/count.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Count observations by group — count • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Count observations by group — count • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,135 +59,141 @@ Count observations by group
Analogous function for count and add_count in dplyr.
- count(.data, ..., sort = FALSE, name = "n")
-
-add_count(.data, ..., name = "n")
-
- Arguments
-
-
- .data
- data.table
-
- ...
- variables to group by.
-
- sort
- logical. If TRUE result will be sorted in desending order by resulting variable.
-
- name
- character. Name of resulting variable. Default uses "n".
-
-
- Value
+
+ count(.data, ..., sort = FALSE, name = "n")
+
+add_count(.data, ..., name = "n")
+
+
+
+ Arguments
- data.table
- Examples
- #> cyl n
-#> <num> <int>
-#> 1: 6 7
-#> 2: 4 11
-#> 3: 8 14count(a,cyl,sort = TRUE)#> cyl n
-#> <num> <int>
-#> 1: 8 14
-#> 2: 4 11
-#> 3: 6 7a#> mpg cyl disp hp drat wt qsec vs am gear carb
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
-#> 2: 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
-#> 3: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
-#> 4: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
-#> 5: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
-#> 6: 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1
-#> 7: 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4
-#> 8: 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
-#> 9: 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
-#> 10: 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4
-#> 11: 17.8 6 167.6 123 3.92 3.440 18.90 1 0 4 4
-#> 12: 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3
-#> 13: 17.3 8 275.8 180 3.07 3.730 17.60 0 0 3 3
-#> 14: 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3
-#> 15: 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4
-#> 16: 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4
-#> 17: 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4
-#> 18: 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1
-#> 19: 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2
-#> 20: 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1
-#> 21: 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1
-#> 22: 15.5 8 318.0 150 2.76 3.520 16.87 0 0 3 2
-#> 23: 15.2 8 304.0 150 3.15 3.435 17.30 0 0 3 2
-#> 24: 13.3 8 350.0 245 3.73 3.840 15.41 0 0 3 4
-#> 25: 19.2 8 400.0 175 3.08 3.845 17.05 0 0 3 2
-#> 26: 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1
-#> 27: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
-#> 28: 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2
-#> 29: 15.8 8 351.0 264 4.22 3.170 14.50 0 1 5 4
-#> 30: 19.7 6 145.0 175 3.62 2.770 15.50 0 1 5 6
-#> 31: 15.0 8 301.0 335 3.54 3.570 14.60 0 1 5 8
-#> 32: 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2
-#> mpg cyl disp hp drat wt qsec vs am gear carb#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
-#> <num> <num> <num> <num> <fctr> <int>
-#> 1: 5.1 3.5 1.4 0.2 setosa 50
-#> 2: 4.9 3.0 1.4 0.2 setosa 50
-#> 3: 4.7 3.2 1.3 0.2 setosa 50
-#> 4: 4.6 3.1 1.5 0.2 setosa 50
-#> 5: 5.0 3.6 1.4 0.2 setosa 50
-#> ---
-#> 146: 6.7 3.0 5.2 2.3 virginica 50
-#> 147: 6.3 2.5 5.0 1.9 virginica 50
-#> 148: 6.5 3.0 5.2 2.0 virginica 50
-#> 149: 6.2 3.4 5.4 2.3 virginica 50
-#> 150: 5.9 3.0 5.1 1.8 virginica 50b#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
-#> <num> <num> <num> <num> <fctr> <int>
-#> 1: 5.1 3.5 1.4 0.2 setosa 50
-#> 2: 4.9 3.0 1.4 0.2 setosa 50
-#> 3: 4.7 3.2 1.3 0.2 setosa 50
-#> 4: 4.6 3.1 1.5 0.2 setosa 50
-#> 5: 5.0 3.6 1.4 0.2 setosa 50
-#> ---
-#> 146: 6.7 3.0 5.2 2.3 virginica 50
-#> 147: 6.3 2.5 5.0 1.9 virginica 50
-#> 148: 6.5 3.0 5.2 2.0 virginica 50
-#> 149: 6.2 3.4 5.4 2.3 virginica 50
-#> 150: 5.9 3.0 5.1 1.8 virginica 50
-
-
+
+ Value
+ data.table
+
+
+
+ Examples
+ a = as.data.table(mtcars)
+count(a,cyl)
+#> cyl n
+#> <num> <int>
+#> 1: 6 7
+#> 2: 4 11
+#> 3: 8 14
+count(a,cyl,sort = TRUE)
+#> cyl n
+#> <num> <int>
+#> 1: 8 14
+#> 2: 4 11
+#> 3: 6 7
+a
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
+#> 2: 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
+#> 3: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
+#> 4: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
+#> 5: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
+#> 6: 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1
+#> 7: 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4
+#> 8: 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
+#> 9: 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
+#> 10: 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4
+#> 11: 17.8 6 167.6 123 3.92 3.440 18.90 1 0 4 4
+#> 12: 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3
+#> 13: 17.3 8 275.8 180 3.07 3.730 17.60 0 0 3 3
+#> 14: 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3
+#> 15: 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4
+#> 16: 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4
+#> 17: 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4
+#> 18: 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1
+#> 19: 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2
+#> 20: 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1
+#> 21: 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1
+#> 22: 15.5 8 318.0 150 2.76 3.520 16.87 0 0 3 2
+#> 23: 15.2 8 304.0 150 3.15 3.435 17.30 0 0 3 2
+#> 24: 13.3 8 350.0 245 3.73 3.840 15.41 0 0 3 4
+#> 25: 19.2 8 400.0 175 3.08 3.845 17.05 0 0 3 2
+#> 26: 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1
+#> 27: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
+#> 28: 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2
+#> 29: 15.8 8 351.0 264 4.22 3.170 14.50 0 1 5 4
+#> 30: 19.7 6 145.0 175 3.62 2.770 15.50 0 1 5 6
+#> 31: 15.0 8 301.0 335 3.54 3.570 14.60 0 1 5 8
+#> 32: 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+
+b = as.data.table(iris)
+b %>% add_count(Species,name = "N")
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
+#> <num> <num> <num> <num> <fctr> <int>
+#> 1: 5.1 3.5 1.4 0.2 setosa 50
+#> 2: 4.9 3.0 1.4 0.2 setosa 50
+#> 3: 4.7 3.2 1.3 0.2 setosa 50
+#> 4: 4.6 3.1 1.5 0.2 setosa 50
+#> 5: 5.0 3.6 1.4 0.2 setosa 50
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica 50
+#> 147: 6.3 2.5 5.0 1.9 virginica 50
+#> 148: 6.5 3.0 5.2 2.0 virginica 50
+#> 149: 6.2 3.4 5.4 2.3 virginica 50
+#> 150: 5.9 3.0 5.1 1.8 virginica 50
+b
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
+#> <num> <num> <num> <num> <fctr> <int>
+#> 1: 5.1 3.5 1.4 0.2 setosa 50
+#> 2: 4.9 3.0 1.4 0.2 setosa 50
+#> 3: 4.7 3.2 1.3 0.2 setosa 50
+#> 4: 4.6 3.1 1.5 0.2 setosa 50
+#> 5: 5.0 3.6 1.4 0.2 setosa 50
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica 50
+#> 147: 6.3 2.5 5.0 1.9 virginica 50
+#> 148: 6.5 3.0 5.2 2.0 virginica 50
+#> 149: 6.2 3.4 5.4 2.3 virginica 50
+#> 150: 5.9 3.0 5.1 1.8 virginica 50
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/cummean.html b/docs/reference/cummean.html
index 5d73212..bd15ddf 100644
--- a/docs/reference/cummean.html
+++ b/docs/reference/cummean.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Cumulative mean — cummean • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Cumulative mean — cummean • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,54 +59,52 @@ Cumulative mean
Returns a vector whose elements are the cumulative mean of the elements of the argument.
- cummean(x)
+
+ cummean(x)
+
- Arguments
-
-
- x
- a numeric or complex object,
-or an object that can be coerced to one of these.
-
+
-
+
+ Value
+ A numeric vector
+
+
+ Examples
+ cummean(1:10)
+#> [1] 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0 5.5
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/distinct.html b/docs/reference/distinct.html
index 2ef71bc..f89f37f 100644
--- a/docs/reference/distinct.html
+++ b/docs/reference/distinct.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Select distinct/unique rows in data.table — distinct • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Select distinct/unique rows in data.table — distinct • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,83 +59,83 @@ Select distinct/unique rows in data.table
Analogous function for distinct in dplyr
- distinct(.data, ..., .keep_all = FALSE)
-
- Arguments
-
-
- .data
- data.table
-
- ...
- Optional variables to use when determining uniqueness.
+
+ distinct(.data, ..., .keep_all = FALSE)
+
+
+
-
- .keep_all
- If TRUE, keep all variables in data.table. If a combination of ... is not distinct,
-this keeps the first row of values.
-
+If omitted, will use all variables.
+
- Value
+.keep_all
+If TRUE, keep all variables in data.table. If a combination of ... is not distinct,
+this keeps the first row of values.
Value
data.table
- See also
-
-
-
- Examples
- #> Species
-#> <fctr>
-#> 1: setosa
-#> 2: versicolor
-#> 3: virginica b %>% distinct(cyl,vs,.keep_all = TRUE)#> mpg cyl disp hp drat wt qsec vs am gear carb
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
-#> 2: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
-#> 3: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
-#> 4: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
-#> 5: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
-
-
-
-
+
+ See also
+
+
+
+ Examples
+
+ a = as.data.table(iris)
+ b = as.data.table(mtcars)
+ a %>% distinct(Species)
+#> Species
+#> <fctr>
+#> 1: setosa
+#> 2: versicolor
+#> 3: virginica
+ b %>% distinct(cyl,vs,.keep_all = TRUE)
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
+#> 2: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
+#> 3: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
+#> 4: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
+#> 5: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
+
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/drop_delete_na.html b/docs/reference/drop_delete_na.html
index 3699b00..a05fd54 100644
--- a/docs/reference/drop_delete_na.html
+++ b/docs/reference/drop_delete_na.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Drop or delete data by rows or columns — drop_na • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Drop or delete data by rows or columns — drop_na • tidyft
-
+
-
-
-
-
-
-
-
-
+
Drop or delete data by rows or columns
- Source: R/drop_delete_na.R
+ Source: R/drop_delete_na.R
drop_delete_na.Rd
@@ -136,104 +61,114 @@ Drop or delete data by rows or columns
delete_na deletes rows or columns with too many NAs.
- drop_na(.data, ...)
-
-delete_na(.data, MARGIN, n)
-
- Arguments
-
-
- .data
- A data.table
-
- ...
- Colunms to be dropped or deleted.
-
- MARGIN
- 1 or 2. 1 for deleting rows, 2 for deleting columns.
-
- n
- If number (proportion) of NAs is larger than or equal to "n",
-the columns/rows would be deleted. When smaller than 1, use as proportion.
-When larger or equal to 1, use as number.
-
+
+ drop_na(.data, ...)
+
+delete_na(.data, MARGIN, n)
+
- Value
+
+ Arguments
- A data.table
- Examples
- #> x y z
-#> <num> <num> <lgcl>
-#> 1: 1 NA NA
-#> 2: 2 NA NA
-#> 3: NA 4 NA
-#> 4: 3 5 NAx %>% delete_na(2,0.75)#> x y
-#> <num> <num>
-#> 1: 1 NA
-#> 2: 2 NA
-#> 3: NA 4
-#> 4: 3 5#> x
-#> <num>
-#> 1: 1
-#> 2: 2
-#> 3: NA
-#> 4: 3#> Null data.table (0 rows and 0 cols)#> x
-#> <num>
-#> 1: 1
-#> 2: 2
-#> 3: NA
-#> 4: 3#> x y z
-#> <num> <num> <lgcl>
-#> 1: 3 5 NA#> x y z
-#> <num> <num> <lgcl>
-#> 1: 3 5 NA
-
-
-
-
+
+ Value
+ A data.table
+
+
+
+ Examples
+ x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 1 NA NA
+#> 2: 2 NA NA
+#> 3: NA 4 NA
+#> 4: 3 5 NA
+x %>% delete_na(2,0.75)
+#> x y
+#> <num> <num>
+#> 1: 1 NA
+#> 2: 2 NA
+#> 3: NA 4
+#> 4: 3 5
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,0.5)
+#> x
+#> <num>
+#> 1: 1
+#> 2: 2
+#> 3: NA
+#> 4: 3
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,0.24)
+#> Null data.table (0 rows and 0 cols)
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,2)
+#> x
+#> <num>
+#> 1: 1
+#> 2: 2
+#> 3: NA
+#> 4: 3
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(1,0.6)
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 3 5 NA
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(1,2)
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 3 5 NA
+
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/dummy.html b/docs/reference/dummy.html
index 9a1d3b6..617b998 100644
--- a/docs/reference/dummy.html
+++ b/docs/reference/dummy.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Fast creation of dummy variables — dummy • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Fast creation of dummy variables — dummy • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -136,162 +61,166 @@ Fast creation of dummy variables
This function is useful for statistical analysis when you want binary columns rather than character columns.
- dummy(.data, ..., longname = TRUE)
+
+ dummy(.data, ..., longname = TRUE)
+
+
+
+ Arguments
- Arguments
-
-
- .data
- data.frame
-
- ...
- Columns you want to create dummy variables from.
-Very flexible, find in the examples.
-
- longname
- logical. Should the output column labeled with the
-original column name? Default uses TRUE.
-
- Value
+
+
+ Value
+ data.table
+
+
+ Details
If no columns provided, will return the original data frame.
This function is inspired by fastDummies package, but provides
-simple and precise usage, whereas fastDummies::dummy_cols provides more
+simple and precise usage, whereas fastDummies::dummy_cols provides more
features for statistical usage.
- See also
-
-
-
- Examples
- #> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species_setosa
-#> <num> <num> <num> <num> <num>
-#> 1: 4.3 3.0 1.1 0.1 1
-#> 2: 4.4 2.9 1.4 0.2 1
-#> 3: 4.4 3.0 1.3 0.2 1
-#> 4: 4.4 3.2 1.3 0.2 1
-#> 5: 4.5 2.3 1.3 0.3 1
-#> ---
-#> 146: 7.7 2.6 6.9 2.3 0
-#> 147: 7.7 2.8 6.7 2.0 0
-#> 148: 7.7 3.0 6.1 2.3 0
-#> 149: 7.7 3.8 6.7 2.2 0
-#> 150: 7.9 3.8 6.4 2.0 0
-#> Species_versicolor Species_virginica
-#> <num> <num>
-#> 1: 0 0
-#> 2: 0 0
-#> 3: 0 0
-#> 4: 0 0
-#> 5: 0 0
-#> ---
-#> 146: 0 1
-#> 147: 0 1
-#> 148: 0 1
-#> 149: 0 1
-#> 150: 0 1iris %>% dummy(Species,longname = FALSE)#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width setosa versicolor
-#> <num> <num> <num> <num> <num> <num>
-#> 1: 4.3 3.0 1.1 0.1 1 0
-#> 2: 4.4 2.9 1.4 0.2 1 0
-#> 3: 4.4 3.0 1.3 0.2 1 0
-#> 4: 4.4 3.2 1.3 0.2 1 0
-#> 5: 4.5 2.3 1.3 0.3 1 0
-#> ---
-#> 146: 7.7 2.6 6.9 2.3 0 0
-#> 147: 7.7 2.8 6.7 2.0 0 0
-#> 148: 7.7 3.0 6.1 2.3 0 0
-#> 149: 7.7 3.8 6.7 2.2 0 0
-#> 150: 7.9 3.8 6.4 2.0 0 0
-#> virginica
-#> <num>
-#> 1: 0
-#> 2: 0
-#> 3: 0
-#> 4: 0
-#> 5: 0
-#> ---
-#> 146: 1
-#> 147: 1
-#> 148: 1
-#> 149: 1
-#> 150: 1#> Key: <mpg, cyl, disp, hp, drat, wt, qsec, gear, carb, vs_0, vs_1>
-#> mpg cyl disp hp drat wt qsec gear carb vs_0 vs_1 am_0
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 18.1 6 225 105 2.76 3.460 20.22 3 1 0 1 1
-#> 2: 18.7 8 360 175 3.15 3.440 17.02 3 2 1 0 1
-#> 3: 21.0 6 160 110 3.90 2.620 16.46 4 4 1 0 0
-#> 4: 21.0 6 160 110 3.90 2.875 17.02 4 4 1 0 0
-#> 5: 21.4 6 258 110 3.08 3.215 19.44 3 1 0 1 1
-#> 6: 22.8 4 108 93 3.85 2.320 18.61 4 1 0 1 0
-#> am_1
-#> <num>
-#> 1: 0
-#> 2: 0
-#> 3: 1
-#> 4: 1
-#> 5: 0
-#> 6: 1#> Key: <mpg, disp, hp, drat, wt, qsec, vs, am, carb, cyl_4, cyl_6, cyl_8>
-#> mpg disp hp drat wt qsec vs am carb cyl_4 cyl_6 cyl_8
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 18.1 225 105 2.76 3.460 20.22 1 0 1 0 1 0
-#> 2: 18.7 360 175 3.15 3.440 17.02 0 0 2 0 0 1
-#> 3: 21.0 160 110 3.90 2.620 16.46 0 1 4 0 1 0
-#> 4: 21.0 160 110 3.90 2.875 17.02 0 1 4 0 1 0
-#> 5: 21.4 258 110 3.08 3.215 19.44 1 0 1 0 1 0
-#> 6: 22.8 108 93 3.85 2.320 18.61 1 1 1 1 0 0
-#> gear_3 gear_4
-#> <num> <num>
-#> 1: 1 0
-#> 2: 1 0
-#> 3: 0 1
-#> 4: 0 1
-#> 5: 1 0
-#> 6: 0 1
-
-
-
+
+ See also
+ dummy_cols
+
+
+ Examples
+
+iris = as.data.table(iris)
+iris %>% dummy(Species)
+#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species_setosa
+#> <num> <num> <num> <num> <num>
+#> 1: 4.3 3.0 1.1 0.1 1
+#> 2: 4.4 2.9 1.4 0.2 1
+#> 3: 4.4 3.0 1.3 0.2 1
+#> 4: 4.4 3.2 1.3 0.2 1
+#> 5: 4.5 2.3 1.3 0.3 1
+#> ---
+#> 146: 7.7 2.6 6.9 2.3 0
+#> 147: 7.7 2.8 6.7 2.0 0
+#> 148: 7.7 3.0 6.1 2.3 0
+#> 149: 7.7 3.8 6.7 2.2 0
+#> 150: 7.9 3.8 6.4 2.0 0
+#> Species_versicolor Species_virginica
+#> <num> <num>
+#> 1: 0 0
+#> 2: 0 0
+#> 3: 0 0
+#> 4: 0 0
+#> 5: 0 0
+#> ---
+#> 146: 0 1
+#> 147: 0 1
+#> 148: 0 1
+#> 149: 0 1
+#> 150: 0 1
+iris %>% dummy(Species,longname = FALSE)
+#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width setosa versicolor
+#> <num> <num> <num> <num> <num> <num>
+#> 1: 4.3 3.0 1.1 0.1 1 0
+#> 2: 4.4 2.9 1.4 0.2 1 0
+#> 3: 4.4 3.0 1.3 0.2 1 0
+#> 4: 4.4 3.2 1.3 0.2 1 0
+#> 5: 4.5 2.3 1.3 0.3 1 0
+#> ---
+#> 146: 7.7 2.6 6.9 2.3 0 0
+#> 147: 7.7 2.8 6.7 2.0 0 0
+#> 148: 7.7 3.0 6.1 2.3 0 0
+#> 149: 7.7 3.8 6.7 2.2 0 0
+#> 150: 7.9 3.8 6.4 2.0 0 0
+#> virginica
+#> <num>
+#> 1: 0
+#> 2: 0
+#> 3: 0
+#> 4: 0
+#> 5: 0
+#> ---
+#> 146: 1
+#> 147: 1
+#> 148: 1
+#> 149: 1
+#> 150: 1
+
+mtcars = as.data.table(mtcars)
+mtcars %>% head() %>% dummy(vs,am)
+#> Key: <mpg, cyl, disp, hp, drat, wt, qsec, gear, carb, vs_0, vs_1>
+#> mpg cyl disp hp drat wt qsec gear carb vs_0 vs_1 am_0
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 18.1 6 225 105 2.76 3.460 20.22 3 1 0 1 1
+#> 2: 18.7 8 360 175 3.15 3.440 17.02 3 2 1 0 1
+#> 3: 21.0 6 160 110 3.90 2.620 16.46 4 4 1 0 0
+#> 4: 21.0 6 160 110 3.90 2.875 17.02 4 4 1 0 0
+#> 5: 21.4 6 258 110 3.08 3.215 19.44 3 1 0 1 1
+#> 6: 22.8 4 108 93 3.85 2.320 18.61 4 1 0 1 0
+#> am_1
+#> <num>
+#> 1: 0
+#> 2: 0
+#> 3: 1
+#> 4: 1
+#> 5: 0
+#> 6: 1
+mtcars %>% head() %>% dummy("cyl|gear")
+#> Key: <mpg, disp, hp, drat, wt, qsec, vs, am, carb, cyl_4, cyl_6, cyl_8>
+#> mpg disp hp drat wt qsec vs am carb cyl_4 cyl_6 cyl_8
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 18.1 225 105 2.76 3.460 20.22 1 0 1 0 1 0
+#> 2: 18.7 360 175 3.15 3.440 17.02 0 0 2 0 0 1
+#> 3: 21.0 160 110 3.90 2.620 16.46 0 1 4 0 1 0
+#> 4: 21.0 160 110 3.90 2.875 17.02 0 1 4 0 1 0
+#> 5: 21.4 258 110 3.08 3.215 19.44 1 0 1 0 1 0
+#> 6: 22.8 108 93 3.85 2.320 18.61 1 1 1 1 0 0
+#> gear_3 gear_4
+#> <num> <num>
+#> 1: 1 0
+#> 2: 1 0
+#> 3: 0 1
+#> 4: 0 1
+#> 5: 1 0
+#> 6: 0 1
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/fill.html b/docs/reference/fill.html
index 83680bc..c38eda6 100644
--- a/docs/reference/fill.html
+++ b/docs/reference/fill.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Fill in missing values with previous or next value — fill • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Fill in missing values with previous or next value — fill • tidyft
-
-
+
-
-
-
-
-
-
-
+
@@ -134,116 +59,118 @@ Fill in missing values with previous or next value
Fills missing values in selected columns using the next or previous entry.
- fill(.data, ..., direction = "down")
-
-shift_fill(x, direction = "down")
-
- Arguments
-
-
- .data
- A data.table
-
- ...
- A selection of columns.
-
- direction
- Direction in which to fill missing values.
-Currently either "down" (the default), "up".
-
- x
- A vector.
-
-
- Value
+
+ fill(.data, ..., direction = "down")
+
+shift_fill(x, direction = "down")
+
- A filled data.table
- Details
+
+ Arguments
+
+
+
+
+ Value
+ A filled data.table
+
+
+ Details
fill is filling data.table's columns,
shift_fill is filling any vectors.
+
- Examples
- #> Month Year
-#> <int> <num>
-#> 1: 1 2000
-#> 2: 2 NA
-#> 3: 3 NA
-#> 4: 4 NA
-#> 5: 5 NA
-#> 6: 6 NA
-#> 7: 7 NA
-#> 8: 8 NA
-#> 9: 9 NA
-#> 10: 10 NA
-#> 11: 11 NA
-#> 12: 12 2001df %>% fill(Year)#> Month Year
-#> <int> <num>
-#> 1: 1 2000
-#> 2: 2 2000
-#> 3: 3 2000
-#> 4: 4 2000
-#> 5: 5 2000
-#> 6: 6 2000
-#> 7: 7 2000
-#> 8: 8 2000
-#> 9: 9 2000
-#> 10: 10 2000
-#> 11: 11 2000
-#> 12: 12 2001
-df <- data.table(Month = 1:12, Year = c(2000, rep(NA, 10),2001))
-df %>% fill(Year,direction = "up")#> Month Year
-#> <int> <num>
-#> 1: 1 2000
-#> 2: 2 2001
-#> 3: 3 2001
-#> 4: 4 2001
-#> 5: 5 2001
-#> 6: 6 2001
-#> 7: 7 2001
-#> 8: 8 2001
-#> 9: 9 2001
-#> 10: 10 2001
-#> 11: 11 2001
-#> 12: 12 2001
-
-
-
+
-
+
+
-
-
-
+
diff --git a/docs/reference/filter.html b/docs/reference/filter.html
index ae0be81..e8d10dc 100644
--- a/docs/reference/filter.html
+++ b/docs/reference/filter.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Filter entries in data.frame — filter • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Filter entries in data.frame — filter • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,96 +59,100 @@ Filter entries in data.frame
Analogous function for filter in dplyr.
- filter(.data, ...)
+
+ filter(.data, ...)
+
- Arguments
-
-
- .data
- data.frame
-
- ...
- List of variables or name-value pairs of summary/modifications
-functions.
-
+
+
+ Value
+ A data.table
+
+
+ Details
Currently data.table is not able to delete rows by reference,
- References
-
- https://github.com/Rdatatable/data.table/issues/635
-https://stackoverflow.com/questions/10790204/how-to-delete-a-row-by-reference-in-data-table
- See also
-
-
-
- Examples
- #> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.1 3.0 5.9 2.1 virginica
-#> 2: 7.6 3.0 6.6 2.1 virginica
-#> 3: 7.3 2.9 6.3 1.8 virginica
-#> 4: 7.2 3.6 6.1 2.5 virginica
-#> 5: 7.7 3.8 6.7 2.2 virginica
-#> 6: 7.7 2.6 6.9 2.3 virginica
-#> 7: 7.7 2.8 6.7 2.0 virginica
-#> 8: 7.2 3.2 6.0 1.8 virginica
-#> 9: 7.2 3.0 5.8 1.6 virginica
-#> 10: 7.4 2.8 6.1 1.9 virginica
-#> 11: 7.9 3.8 6.4 2.0 virginica
-#> 12: 7.7 3.0 6.1 2.3 virginicairis %>% filter(Sepal.Length > 7,Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.2 3.6 6.1 2.5 virginica
-#> 2: 7.7 3.8 6.7 2.2 virginica
-#> 3: 7.2 3.2 6.0 1.8 virginica
-#> 4: 7.9 3.8 6.4 2.0 virginicairis %>% filter(Sepal.Length > 7 & Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.2 3.6 6.1 2.5 virginica
-#> 2: 7.7 3.8 6.7 2.2 virginica
-#> 3: 7.2 3.2 6.0 1.8 virginica
-#> 4: 7.9 3.8 6.4 2.0 virginica#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.9 3.8 6.4 2 virginica
-
-
+
+ References
+ https://github.com/Rdatatable/data.table/issues/635
+https://stackoverflow.com/questions/10790204/how-to-delete-a-row-by-reference-in-data-table
+
+
+ See also
+
+
+
+ Examples
+ iris = as.data.table(iris)
+iris %>% filter(Sepal.Length > 7)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.1 3.0 5.9 2.1 virginica
+#> 2: 7.6 3.0 6.6 2.1 virginica
+#> 3: 7.3 2.9 6.3 1.8 virginica
+#> 4: 7.2 3.6 6.1 2.5 virginica
+#> 5: 7.7 3.8 6.7 2.2 virginica
+#> 6: 7.7 2.6 6.9 2.3 virginica
+#> 7: 7.7 2.8 6.7 2.0 virginica
+#> 8: 7.2 3.2 6.0 1.8 virginica
+#> 9: 7.2 3.0 5.8 1.6 virginica
+#> 10: 7.4 2.8 6.1 1.9 virginica
+#> 11: 7.9 3.8 6.4 2.0 virginica
+#> 12: 7.7 3.0 6.1 2.3 virginica
+iris %>% filter(Sepal.Length > 7,Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.2 3.6 6.1 2.5 virginica
+#> 2: 7.7 3.8 6.7 2.2 virginica
+#> 3: 7.2 3.2 6.0 1.8 virginica
+#> 4: 7.9 3.8 6.4 2.0 virginica
+iris %>% filter(Sepal.Length > 7 & Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.2 3.6 6.1 2.5 virginica
+#> 2: 7.7 3.8 6.7 2.2 virginica
+#> 3: 7.2 3.2 6.0 1.8 virginica
+#> 4: 7.9 3.8 6.4 2.0 virginica
+iris %>% filter(Sepal.Length == max(Sepal.Length))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.9 3.8 6.4 2 virginica
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/fst.html b/docs/reference/fst.html
index d973203..76cc349 100644
--- a/docs/reference/fst.html
+++ b/docs/reference/fst.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Parse,inspect and extract data.table from fst file — fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Parse,inspect and extract data.table from fst file — fst • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,366 +59,403 @@ Parse,inspect and extract data.table from fst file
An API for reading fst file as data.table.
- parse_fst(path)
+
+ parse_fst(path)
+
+slice_fst(ft, row_no)
+
+select_fst(ft, ...)
+
+filter_fst(ft, ...)
+
+summary_fst(ft)
+
+
+
+ Arguments
+
-slice_fst(ft, row_no)
+- path
+path to fst file
- ft
+An object of class fst_table, returned by parse_fst
Arguments
-
-
- path
- path to fst file
-
- ft
- An object of class fst_table, returned by parse_fst
-
- row_no
- An integer vector (Positive)
-
- ...
- The filter conditions
-
+- row_no
+An integer vector (Positive)
Value
+- ...
+The filter conditions
+
+ Value
parse_fst returns a fst_table class.
select_fst and filter_fst returns a data.table.
- Details
-
+
+
+ Details
summary_fst could provide some basic information about
the fst table.
- See also
-
-
-
- Examples
-
- # write the file first
- path = tempfile(fileext = ".fst")
- fst::write_fst(iris,path)
- # parse the file but not reading it
- parse_fst(path) -> ft
-
- ft#> <fst file>
-#> 150 rows, 5 columns (filea5434c14328.fst)
-#>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <double> <double> <double> <double> <factor>
-#> 1 5.1 3.5 1.4 0.2 setosa
-#> 2 4.9 3.0 1.4 0.2 setosa
-#> 3 4.7 3.2 1.3 0.2 setosa
-#> 4 4.6 3.1 1.5 0.2 setosa
-#> 5 5.0 3.6 1.4 0.2 setosa
-#> -- -- -- -- -- --
-#> 146 6.7 3.0 5.2 2.3 virginica
-#> 147 6.3 2.5 5.0 1.9 virginica
-#> 148 6.5 3.0 5.2 2.0 virginica
-#> 149 6.2 3.4 5.4 2.3 virginica
-#> 150 5.9 3.0 5.1 1.8 virginica
- class(ft)#> [1] "fst_table"#> $Sepal.Length
-#> [1] "numeric"
-#>
-#> $Sepal.Width
-#> [1] "numeric"
-#>
-#> $Petal.Length
-#> [1] "numeric"
-#>
-#> $Petal.Width
-#> [1] "numeric"
-#>
-#> $Species
-#> [1] "factor"
-#> names(ft)#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species" dim(ft)#> [1] 150 5 summary_fst(ft)#> <fst file>
-#> 150 rows, 5 columns (filea5434c14328.fst)
-#>
-#> * 'Sepal.Length': double
-#> * 'Sepal.Width' : double
-#> * 'Petal.Length': double
-#> * 'Petal.Width' : double
-#> * 'Species' : factor
- # get the data by query
- ft %>% slice_fst(1:3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.9 3.0 1.4 0.2 setosa
-#> 3: 4.7 3.2 1.3 0.2 setosa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.7 3.2 1.3 0.2 setosa
- ft %>% select_fst(Sepal.Length)#> Sepal.Length
-#> <num>
-#> 1: 5.1
-#> 2: 4.9
-#> 3: 4.7
-#> 4: 4.6
-#> 5: 5.0
-#> ---
-#> 146: 6.7
-#> 147: 6.3
-#> 148: 6.5
-#> 149: 6.2
-#> 150: 5.9 ft %>% select_fst(Sepal.Length,Sepal.Width)#> Sepal.Length Sepal.Width
-#> <num> <num>
-#> 1: 5.1 3.5
-#> 2: 4.9 3.0
-#> 3: 4.7 3.2
-#> 4: 4.6 3.1
-#> 5: 5.0 3.6
-#> ---
-#> 146: 6.7 3.0
-#> 147: 6.3 2.5
-#> 148: 6.5 3.0
-#> 149: 6.2 3.4
-#> 150: 5.9 3.0 ft %>% select_fst("Sepal.Length")#> Sepal.Length
-#> <num>
-#> 1: 5.1
-#> 2: 4.9
-#> 3: 4.7
-#> 4: 4.6
-#> 5: 5.0
-#> ---
-#> 146: 6.7
-#> 147: 6.3
-#> 148: 6.5
-#> 149: 6.2
-#> 150: 5.9 ft %>% select_fst(1:3)#> Sepal.Length Sepal.Width Petal.Length
-#> <num> <num> <num>
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4
-#> ---
-#> 146: 6.7 3.0 5.2
-#> 147: 6.3 2.5 5.0
-#> 148: 6.5 3.0 5.2
-#> 149: 6.2 3.4 5.4
-#> 150: 5.9 3.0 5.1 ft %>% select_fst(1,3)#> Sepal.Length Petal.Length
-#> <num> <num>
-#> 1: 5.1 1.4
-#> 2: 4.9 1.4
-#> 3: 4.7 1.3
-#> 4: 4.6 1.5
-#> 5: 5.0 1.4
-#> ---
-#> 146: 6.7 5.2
-#> 147: 6.3 5.0
-#> 148: 6.5 5.2
-#> 149: 6.2 5.4
-#> 150: 5.9 5.1 ft %>% select_fst("Se")#> Sepal.Length Sepal.Width
-#> <num> <num>
-#> 1: 5.1 3.5
-#> 2: 4.9 3.0
-#> 3: 4.7 3.2
-#> 4: 4.6 3.1
-#> 5: 5.0 3.6
-#> ---
-#> 146: 6.7 3.0
-#> 147: 6.3 2.5
-#> 148: 6.5 3.0
-#> 149: 6.2 3.4
-#> 150: 5.9 3.0
- # return a warning with message
- # \donttest{
- ft %>% select_fst("nothing")#> Warning: No matched columns,try other patterns. Names of the `fst_table` are listed.#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species" # }
-
- ft %>% select_fst("Se|Sp")#> Sepal.Length Sepal.Width Species
-#> <num> <num> <fctr>
-#> 1: 5.1 3.5 setosa
-#> 2: 4.9 3.0 setosa
-#> 3: 4.7 3.2 setosa
-#> 4: 4.6 3.1 setosa
-#> 5: 5.0 3.6 setosa
-#> ---
-#> 146: 6.7 3.0 virginica
-#> 147: 6.3 2.5 virginica
-#> 148: 6.5 3.0 virginica
-#> 149: 6.2 3.4 virginica
-#> 150: 5.9 3.0 virginica#> Sepal.Width Petal.Length
-#> <num> <num>
-#> 1: 3.5 1.4
-#> 2: 3.0 1.4
-#> 3: 3.2 1.3
-#> 4: 3.1 1.5
-#> 5: 3.6 1.4
-#> ---
-#> 146: 3.0 5.2
-#> 147: 2.5 5.0
-#> 148: 3.0 5.2
-#> 149: 3.4 5.4
-#> 150: 3.0 5.1
- ft %>% filter_fst(Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.7 3.2 1.3 0.2 setosa
-#> 3: 4.6 3.1 1.5 0.2 setosa
-#> 4: 5.0 3.6 1.4 0.2 setosa
-#> 5: 5.4 3.9 1.7 0.4 setosa
-#> 6: 4.6 3.4 1.4 0.3 setosa
-#> 7: 5.0 3.4 1.5 0.2 setosa
-#> 8: 4.9 3.1 1.5 0.1 setosa
-#> 9: 5.4 3.7 1.5 0.2 setosa
-#> 10: 4.8 3.4 1.6 0.2 setosa
-#> 11: 5.8 4.0 1.2 0.2 setosa
-#> 12: 5.7 4.4 1.5 0.4 setosa
-#> 13: 5.4 3.9 1.3 0.4 setosa
-#> 14: 5.1 3.5 1.4 0.3 setosa
-#> 15: 5.7 3.8 1.7 0.3 setosa
-#> 16: 5.1 3.8 1.5 0.3 setosa
-#> 17: 5.4 3.4 1.7 0.2 setosa
-#> 18: 5.1 3.7 1.5 0.4 setosa
-#> 19: 4.6 3.6 1.0 0.2 setosa
-#> 20: 5.1 3.3 1.7 0.5 setosa
-#> 21: 4.8 3.4 1.9 0.2 setosa
-#> 22: 5.0 3.4 1.6 0.4 setosa
-#> 23: 5.2 3.5 1.5 0.2 setosa
-#> 24: 5.2 3.4 1.4 0.2 setosa
-#> 25: 4.7 3.2 1.6 0.2 setosa
-#> 26: 4.8 3.1 1.6 0.2 setosa
-#> 27: 5.4 3.4 1.5 0.4 setosa
-#> 28: 5.2 4.1 1.5 0.1 setosa
-#> 29: 5.5 4.2 1.4 0.2 setosa
-#> 30: 4.9 3.1 1.5 0.2 setosa
-#> 31: 5.0 3.2 1.2 0.2 setosa
-#> 32: 5.5 3.5 1.3 0.2 setosa
-#> 33: 4.9 3.6 1.4 0.1 setosa
-#> 34: 5.1 3.4 1.5 0.2 setosa
-#> 35: 5.0 3.5 1.3 0.3 setosa
-#> 36: 4.4 3.2 1.3 0.2 setosa
-#> 37: 5.0 3.5 1.6 0.6 setosa
-#> 38: 5.1 3.8 1.9 0.4 setosa
-#> 39: 5.1 3.8 1.6 0.2 setosa
-#> 40: 4.6 3.2 1.4 0.2 setosa
-#> 41: 5.3 3.7 1.5 0.2 setosa
-#> 42: 5.0 3.3 1.4 0.2 setosa
-#> 43: 7.0 3.2 4.7 1.4 versicolor
-#> 44: 6.4 3.2 4.5 1.5 versicolor
-#> 45: 6.9 3.1 4.9 1.5 versicolor
-#> 46: 6.3 3.3 4.7 1.6 versicolor
-#> 47: 6.7 3.1 4.4 1.4 versicolor
-#> 48: 5.9 3.2 4.8 1.8 versicolor
-#> 49: 6.0 3.4 4.5 1.6 versicolor
-#> 50: 6.7 3.1 4.7 1.5 versicolor
-#> 51: 6.3 3.3 6.0 2.5 virginica
-#> 52: 7.2 3.6 6.1 2.5 virginica
-#> 53: 6.5 3.2 5.1 2.0 virginica
-#> 54: 6.4 3.2 5.3 2.3 virginica
-#> 55: 7.7 3.8 6.7 2.2 virginica
-#> 56: 6.9 3.2 5.7 2.3 virginica
-#> 57: 6.7 3.3 5.7 2.1 virginica
-#> 58: 7.2 3.2 6.0 1.8 virginica
-#> 59: 7.9 3.8 6.4 2.0 virginica
-#> 60: 6.3 3.4 5.6 2.4 virginica
-#> 61: 6.4 3.1 5.5 1.8 virginica
-#> 62: 6.9 3.1 5.4 2.1 virginica
-#> 63: 6.7 3.1 5.6 2.4 virginica
-#> 64: 6.9 3.1 5.1 2.3 virginica
-#> 65: 6.8 3.2 5.9 2.3 virginica
-#> 66: 6.7 3.3 5.7 2.5 virginica
-#> 67: 6.2 3.4 5.4 2.3 virginica
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species ft %>% filter_fst(Sepal.Length > 6 , Species == "virginica")#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 6.3 3.3 6.0 2.5 virginica
-#> 2: 7.1 3.0 5.9 2.1 virginica
-#> 3: 6.3 2.9 5.6 1.8 virginica
-#> 4: 6.5 3.0 5.8 2.2 virginica
-#> 5: 7.6 3.0 6.6 2.1 virginica
-#> 6: 7.3 2.9 6.3 1.8 virginica
-#> 7: 6.7 2.5 5.8 1.8 virginica
-#> 8: 7.2 3.6 6.1 2.5 virginica
-#> 9: 6.5 3.2 5.1 2.0 virginica
-#> 10: 6.4 2.7 5.3 1.9 virginica
-#> 11: 6.8 3.0 5.5 2.1 virginica
-#> 12: 6.4 3.2 5.3 2.3 virginica
-#> 13: 6.5 3.0 5.5 1.8 virginica
-#> 14: 7.7 3.8 6.7 2.2 virginica
-#> 15: 7.7 2.6 6.9 2.3 virginica
-#> 16: 6.9 3.2 5.7 2.3 virginica
-#> 17: 7.7 2.8 6.7 2.0 virginica
-#> 18: 6.3 2.7 4.9 1.8 virginica
-#> 19: 6.7 3.3 5.7 2.1 virginica
-#> 20: 7.2 3.2 6.0 1.8 virginica
-#> 21: 6.2 2.8 4.8 1.8 virginica
-#> 22: 6.1 3.0 4.9 1.8 virginica
-#> 23: 6.4 2.8 5.6 2.1 virginica
-#> 24: 7.2 3.0 5.8 1.6 virginica
-#> 25: 7.4 2.8 6.1 1.9 virginica
-#> 26: 7.9 3.8 6.4 2.0 virginica
-#> 27: 6.4 2.8 5.6 2.2 virginica
-#> 28: 6.3 2.8 5.1 1.5 virginica
-#> 29: 6.1 2.6 5.6 1.4 virginica
-#> 30: 7.7 3.0 6.1 2.3 virginica
-#> 31: 6.3 3.4 5.6 2.4 virginica
-#> 32: 6.4 3.1 5.5 1.8 virginica
-#> 33: 6.9 3.1 5.4 2.1 virginica
-#> 34: 6.7 3.1 5.6 2.4 virginica
-#> 35: 6.9 3.1 5.1 2.3 virginica
-#> 36: 6.8 3.2 5.9 2.3 virginica
-#> 37: 6.7 3.3 5.7 2.5 virginica
-#> 38: 6.7 3.0 5.2 2.3 virginica
-#> 39: 6.3 2.5 5.0 1.9 virginica
-#> 40: 6.5 3.0 5.2 2.0 virginica
-#> 41: 6.2 3.4 5.4 2.3 virginica
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species ft %>% filter_fst(Sepal.Length > 6 & Species == "virginica" & Sepal.Width < 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 6.3 2.9 5.6 1.8 virginica
-#> 2: 7.3 2.9 6.3 1.8 virginica
-#> 3: 6.7 2.5 5.8 1.8 virginica
-#> 4: 6.4 2.7 5.3 1.9 virginica
-#> 5: 7.7 2.6 6.9 2.3 virginica
-#> 6: 7.7 2.8 6.7 2.0 virginica
-#> 7: 6.3 2.7 4.9 1.8 virginica
-#> 8: 6.2 2.8 4.8 1.8 virginica
-#> 9: 6.4 2.8 5.6 2.1 virginica
-#> 10: 7.4 2.8 6.1 1.9 virginica
-#> 11: 6.4 2.8 5.6 2.2 virginica
-#> 12: 6.3 2.8 5.1 1.5 virginica
-#> 13: 6.1 2.6 5.6 1.4 virginica
-#> 14: 6.3 2.5 5.0 1.9 virginica
-
-
-
+
+ See also
+
+
+
+ Examples
+
+ # write the file first
+ path = tempfile(fileext = ".fst")
+ fst::write_fst(iris,path)
+ # parse the file but not reading it
+ parse_fst(path) -> ft
+
+ ft
+#> <fst file>
+#> 150 rows, 5 columns (file27604466d41.fst)
+#>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <double> <double> <double> <double> <factor>
+#> 1 5.1 3.5 1.4 0.2 setosa
+#> 2 4.9 3.0 1.4 0.2 setosa
+#> 3 4.7 3.2 1.3 0.2 setosa
+#> 4 4.6 3.1 1.5 0.2 setosa
+#> 5 5.0 3.6 1.4 0.2 setosa
+#> -- -- -- -- -- --
+#> 146 6.7 3.0 5.2 2.3 virginica
+#> 147 6.3 2.5 5.0 1.9 virginica
+#> 148 6.5 3.0 5.2 2.0 virginica
+#> 149 6.2 3.4 5.4 2.3 virginica
+#> 150 5.9 3.0 5.1 1.8 virginica
+
+ class(ft)
+#> [1] "fst_table"
+ lapply(ft,class)
+#> $Sepal.Length
+#> [1] "numeric"
+#>
+#> $Sepal.Width
+#> [1] "numeric"
+#>
+#> $Petal.Length
+#> [1] "numeric"
+#>
+#> $Petal.Width
+#> [1] "numeric"
+#>
+#> $Species
+#> [1] "factor"
+#>
+ names(ft)
+#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species"
+ dim(ft)
+#> [1] 150 5
+ summary_fst(ft)
+#> <fst file>
+#> 150 rows, 5 columns (file27604466d41.fst)
+#>
+#> * 'Sepal.Length': double
+#> * 'Sepal.Width' : double
+#> * 'Petal.Length': double
+#> * 'Petal.Width' : double
+#> * 'Species' : factor
+
+ # get the data by query
+ ft %>% slice_fst(1:3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.9 3.0 1.4 0.2 setosa
+#> 3: 4.7 3.2 1.3 0.2 setosa
+ ft %>% slice_fst(c(1,3))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.7 3.2 1.3 0.2 setosa
+
+ ft %>% select_fst(Sepal.Length)
+#> Sepal.Length
+#> <num>
+#> 1: 5.1
+#> 2: 4.9
+#> 3: 4.7
+#> 4: 4.6
+#> 5: 5.0
+#> ---
+#> 146: 6.7
+#> 147: 6.3
+#> 148: 6.5
+#> 149: 6.2
+#> 150: 5.9
+ ft %>% select_fst(Sepal.Length,Sepal.Width)
+#> Sepal.Length Sepal.Width
+#> <num> <num>
+#> 1: 5.1 3.5
+#> 2: 4.9 3.0
+#> 3: 4.7 3.2
+#> 4: 4.6 3.1
+#> 5: 5.0 3.6
+#> ---
+#> 146: 6.7 3.0
+#> 147: 6.3 2.5
+#> 148: 6.5 3.0
+#> 149: 6.2 3.4
+#> 150: 5.9 3.0
+ ft %>% select_fst("Sepal.Length")
+#> Sepal.Length
+#> <num>
+#> 1: 5.1
+#> 2: 4.9
+#> 3: 4.7
+#> 4: 4.6
+#> 5: 5.0
+#> ---
+#> 146: 6.7
+#> 147: 6.3
+#> 148: 6.5
+#> 149: 6.2
+#> 150: 5.9
+ ft %>% select_fst(1:3)
+#> Sepal.Length Sepal.Width Petal.Length
+#> <num> <num> <num>
+#> 1: 5.1 3.5 1.4
+#> 2: 4.9 3.0 1.4
+#> 3: 4.7 3.2 1.3
+#> 4: 4.6 3.1 1.5
+#> 5: 5.0 3.6 1.4
+#> ---
+#> 146: 6.7 3.0 5.2
+#> 147: 6.3 2.5 5.0
+#> 148: 6.5 3.0 5.2
+#> 149: 6.2 3.4 5.4
+#> 150: 5.9 3.0 5.1
+ ft %>% select_fst(1,3)
+#> Sepal.Length Petal.Length
+#> <num> <num>
+#> 1: 5.1 1.4
+#> 2: 4.9 1.4
+#> 3: 4.7 1.3
+#> 4: 4.6 1.5
+#> 5: 5.0 1.4
+#> ---
+#> 146: 6.7 5.2
+#> 147: 6.3 5.0
+#> 148: 6.5 5.2
+#> 149: 6.2 5.4
+#> 150: 5.9 5.1
+ ft %>% select_fst("Se")
+#> Sepal.Length Sepal.Width
+#> <num> <num>
+#> 1: 5.1 3.5
+#> 2: 4.9 3.0
+#> 3: 4.7 3.2
+#> 4: 4.6 3.1
+#> 5: 5.0 3.6
+#> ---
+#> 146: 6.7 3.0
+#> 147: 6.3 2.5
+#> 148: 6.5 3.0
+#> 149: 6.2 3.4
+#> 150: 5.9 3.0
+
+ # return a warning with message
+ # \donttest{
+ ft %>% select_fst("nothing")
+#> Warning: No matched columns,try other patterns. Names of the `fst_table` are listed.
+#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species"
+ # }
+
+ ft %>% select_fst("Se|Sp")
+#> Sepal.Length Sepal.Width Species
+#> <num> <num> <fctr>
+#> 1: 5.1 3.5 setosa
+#> 2: 4.9 3.0 setosa
+#> 3: 4.7 3.2 setosa
+#> 4: 4.6 3.1 setosa
+#> 5: 5.0 3.6 setosa
+#> ---
+#> 146: 6.7 3.0 virginica
+#> 147: 6.3 2.5 virginica
+#> 148: 6.5 3.0 virginica
+#> 149: 6.2 3.4 virginica
+#> 150: 5.9 3.0 virginica
+ ft %>% select_fst(cols = names(iris)[2:3])
+#> Sepal.Width Petal.Length
+#> <num> <num>
+#> 1: 3.5 1.4
+#> 2: 3.0 1.4
+#> 3: 3.2 1.3
+#> 4: 3.1 1.5
+#> 5: 3.6 1.4
+#> ---
+#> 146: 3.0 5.2
+#> 147: 2.5 5.0
+#> 148: 3.0 5.2
+#> 149: 3.4 5.4
+#> 150: 3.0 5.1
+
+ ft %>% filter_fst(Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.7 3.2 1.3 0.2 setosa
+#> 3: 4.6 3.1 1.5 0.2 setosa
+#> 4: 5.0 3.6 1.4 0.2 setosa
+#> 5: 5.4 3.9 1.7 0.4 setosa
+#> 6: 4.6 3.4 1.4 0.3 setosa
+#> 7: 5.0 3.4 1.5 0.2 setosa
+#> 8: 4.9 3.1 1.5 0.1 setosa
+#> 9: 5.4 3.7 1.5 0.2 setosa
+#> 10: 4.8 3.4 1.6 0.2 setosa
+#> 11: 5.8 4.0 1.2 0.2 setosa
+#> 12: 5.7 4.4 1.5 0.4 setosa
+#> 13: 5.4 3.9 1.3 0.4 setosa
+#> 14: 5.1 3.5 1.4 0.3 setosa
+#> 15: 5.7 3.8 1.7 0.3 setosa
+#> 16: 5.1 3.8 1.5 0.3 setosa
+#> 17: 5.4 3.4 1.7 0.2 setosa
+#> 18: 5.1 3.7 1.5 0.4 setosa
+#> 19: 4.6 3.6 1.0 0.2 setosa
+#> 20: 5.1 3.3 1.7 0.5 setosa
+#> 21: 4.8 3.4 1.9 0.2 setosa
+#> 22: 5.0 3.4 1.6 0.4 setosa
+#> 23: 5.2 3.5 1.5 0.2 setosa
+#> 24: 5.2 3.4 1.4 0.2 setosa
+#> 25: 4.7 3.2 1.6 0.2 setosa
+#> 26: 4.8 3.1 1.6 0.2 setosa
+#> 27: 5.4 3.4 1.5 0.4 setosa
+#> 28: 5.2 4.1 1.5 0.1 setosa
+#> 29: 5.5 4.2 1.4 0.2 setosa
+#> 30: 4.9 3.1 1.5 0.2 setosa
+#> 31: 5.0 3.2 1.2 0.2 setosa
+#> 32: 5.5 3.5 1.3 0.2 setosa
+#> 33: 4.9 3.6 1.4 0.1 setosa
+#> 34: 5.1 3.4 1.5 0.2 setosa
+#> 35: 5.0 3.5 1.3 0.3 setosa
+#> 36: 4.4 3.2 1.3 0.2 setosa
+#> 37: 5.0 3.5 1.6 0.6 setosa
+#> 38: 5.1 3.8 1.9 0.4 setosa
+#> 39: 5.1 3.8 1.6 0.2 setosa
+#> 40: 4.6 3.2 1.4 0.2 setosa
+#> 41: 5.3 3.7 1.5 0.2 setosa
+#> 42: 5.0 3.3 1.4 0.2 setosa
+#> 43: 7.0 3.2 4.7 1.4 versicolor
+#> 44: 6.4 3.2 4.5 1.5 versicolor
+#> 45: 6.9 3.1 4.9 1.5 versicolor
+#> 46: 6.3 3.3 4.7 1.6 versicolor
+#> 47: 6.7 3.1 4.4 1.4 versicolor
+#> 48: 5.9 3.2 4.8 1.8 versicolor
+#> 49: 6.0 3.4 4.5 1.6 versicolor
+#> 50: 6.7 3.1 4.7 1.5 versicolor
+#> 51: 6.3 3.3 6.0 2.5 virginica
+#> 52: 7.2 3.6 6.1 2.5 virginica
+#> 53: 6.5 3.2 5.1 2.0 virginica
+#> 54: 6.4 3.2 5.3 2.3 virginica
+#> 55: 7.7 3.8 6.7 2.2 virginica
+#> 56: 6.9 3.2 5.7 2.3 virginica
+#> 57: 6.7 3.3 5.7 2.1 virginica
+#> 58: 7.2 3.2 6.0 1.8 virginica
+#> 59: 7.9 3.8 6.4 2.0 virginica
+#> 60: 6.3 3.4 5.6 2.4 virginica
+#> 61: 6.4 3.1 5.5 1.8 virginica
+#> 62: 6.9 3.1 5.4 2.1 virginica
+#> 63: 6.7 3.1 5.6 2.4 virginica
+#> 64: 6.9 3.1 5.1 2.3 virginica
+#> 65: 6.8 3.2 5.9 2.3 virginica
+#> 66: 6.7 3.3 5.7 2.5 virginica
+#> 67: 6.2 3.4 5.4 2.3 virginica
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+ ft %>% filter_fst(Sepal.Length > 6 , Species == "virginica")
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 6.3 3.3 6.0 2.5 virginica
+#> 2: 7.1 3.0 5.9 2.1 virginica
+#> 3: 6.3 2.9 5.6 1.8 virginica
+#> 4: 6.5 3.0 5.8 2.2 virginica
+#> 5: 7.6 3.0 6.6 2.1 virginica
+#> 6: 7.3 2.9 6.3 1.8 virginica
+#> 7: 6.7 2.5 5.8 1.8 virginica
+#> 8: 7.2 3.6 6.1 2.5 virginica
+#> 9: 6.5 3.2 5.1 2.0 virginica
+#> 10: 6.4 2.7 5.3 1.9 virginica
+#> 11: 6.8 3.0 5.5 2.1 virginica
+#> 12: 6.4 3.2 5.3 2.3 virginica
+#> 13: 6.5 3.0 5.5 1.8 virginica
+#> 14: 7.7 3.8 6.7 2.2 virginica
+#> 15: 7.7 2.6 6.9 2.3 virginica
+#> 16: 6.9 3.2 5.7 2.3 virginica
+#> 17: 7.7 2.8 6.7 2.0 virginica
+#> 18: 6.3 2.7 4.9 1.8 virginica
+#> 19: 6.7 3.3 5.7 2.1 virginica
+#> 20: 7.2 3.2 6.0 1.8 virginica
+#> 21: 6.2 2.8 4.8 1.8 virginica
+#> 22: 6.1 3.0 4.9 1.8 virginica
+#> 23: 6.4 2.8 5.6 2.1 virginica
+#> 24: 7.2 3.0 5.8 1.6 virginica
+#> 25: 7.4 2.8 6.1 1.9 virginica
+#> 26: 7.9 3.8 6.4 2.0 virginica
+#> 27: 6.4 2.8 5.6 2.2 virginica
+#> 28: 6.3 2.8 5.1 1.5 virginica
+#> 29: 6.1 2.6 5.6 1.4 virginica
+#> 30: 7.7 3.0 6.1 2.3 virginica
+#> 31: 6.3 3.4 5.6 2.4 virginica
+#> 32: 6.4 3.1 5.5 1.8 virginica
+#> 33: 6.9 3.1 5.4 2.1 virginica
+#> 34: 6.7 3.1 5.6 2.4 virginica
+#> 35: 6.9 3.1 5.1 2.3 virginica
+#> 36: 6.8 3.2 5.9 2.3 virginica
+#> 37: 6.7 3.3 5.7 2.5 virginica
+#> 38: 6.7 3.0 5.2 2.3 virginica
+#> 39: 6.3 2.5 5.0 1.9 virginica
+#> 40: 6.5 3.0 5.2 2.0 virginica
+#> 41: 6.2 3.4 5.4 2.3 virginica
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+ ft %>% filter_fst(Sepal.Length > 6 & Species == "virginica" & Sepal.Width < 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 6.3 2.9 5.6 1.8 virginica
+#> 2: 7.3 2.9 6.3 1.8 virginica
+#> 3: 6.7 2.5 5.8 1.8 virginica
+#> 4: 6.4 2.7 5.3 1.9 virginica
+#> 5: 7.7 2.6 6.9 2.3 virginica
+#> 6: 7.7 2.8 6.7 2.0 virginica
+#> 7: 6.3 2.7 4.9 1.8 virginica
+#> 8: 6.2 2.8 4.8 1.8 virginica
+#> 9: 6.4 2.8 5.6 2.1 virginica
+#> 10: 7.4 2.8 6.1 1.9 virginica
+#> 11: 6.4 2.8 5.6 2.2 virginica
+#> 12: 6.3 2.8 5.1 1.5 virginica
+#> 13: 6.1 2.6 5.6 1.4 virginica
+#> 14: 6.3 2.5 5.0 1.9 virginica
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/fst_io.html b/docs/reference/fst_io.html
index 68160fc..0b22969 100644
--- a/docs/reference/fst_io.html
+++ b/docs/reference/fst_io.html
@@ -1,74 +1,14 @@
-
-
-
-
-
-
-
-Read and write fst files — export_fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Read and write fst files — export_fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
+
- Wrapper for read_fst and write_fst
+
Wrapper for read_fst and write_fst
from fst, but use a different default. For data import, always return a data.table.
For data export, always compress the data to the smallest size.
- export_fst(x, path, compress = 100, uniform_encoding = TRUE)
-
-import_fst(
- path,
- columns = NULL,
- from = 1,
- to = NULL,
- as.data.table = TRUE,
- old_format = FALSE
-)
-
- Arguments
- data.table package to be installed.
+
- Value
+old_format
+must be FALSE, the old fst file format is deprecated and can only be read and
+converted with fst package versions 0.8.0 to 0.8.10.
Value
`import_fst` returns a data.table with the selected columns and rows. `export_fst`
writes `x` to a `fst` file and invisibly returns `x` (so you can use this function in a pipeline).
- See also
-
-
-
- Examples
-
-# \donttest{
-export_fst(iris,"iris_fst_test.fst")
-iris_dt = import_fst("iris_fst_test.fst")
-iris_dt#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.9 3.0 1.4 0.2 setosa
-#> 3: 4.7 3.2 1.3 0.2 setosa
-#> 4: 4.6 3.1 1.5 0.2 setosa
-#> 5: 5.0 3.6 1.4 0.2 setosa
-#> ---
-#> 146: 6.7 3.0 5.2 2.3 virginica
-#> 147: 6.3 2.5 5.0 1.9 virginica
-#> 148: 6.5 3.0 5.2 2.0 virginica
-#> 149: 6.2 3.4 5.4 2.3 virginica
-#> 150: 5.9 3.0 5.1 1.8 virginica
-
-
+
+ See also
+
+
+
+ Examples
+
+# \donttest{
+export_fst(iris,"iris_fst_test.fst")
+iris_dt = import_fst("iris_fst_test.fst")
+iris_dt
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.9 3.0 1.4 0.2 setosa
+#> 3: 4.7 3.2 1.3 0.2 setosa
+#> 4: 4.6 3.1 1.5 0.2 setosa
+#> 5: 5.0 3.6 1.4 0.2 setosa
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica
+#> 147: 6.3 2.5 5.0 1.9 virginica
+#> 148: 6.5 3.0 5.2 2.0 virginica
+#> 149: 6.2 3.4 5.4 2.3 virginica
+#> 150: 5.9 3.0 5.1 1.8 virginica
+unlink("iris_fst_test.fst")
+# }
+
+
+
+
-
+
+
-
-
-
+
`).
+ getTopLevel: function($scope) {
+ for (var i = 1; i <= 6; i++) {
+ var $headings = this.findOrFilter($scope, 'h' + i);
+ if ($headings.length > 1) {
+ return i;
+ }
+ }
+
+ return 1;
+ },
+
+ // returns the elements for the top level, and the next below it
+ getHeadings: function($scope, topLevel) {
+ var topSelector = 'h' + topLevel;
+
+ var secondaryLevel = topLevel + 1;
+ var secondarySelector = 'h' + secondaryLevel;
+
+ return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
+ },
+
+ getNavLevel: function(el) {
+ return parseInt(el.tagName.charAt(1), 10);
+ },
+
+ populateNav: function($topContext, topLevel, $headings) {
+ var $context = $topContext;
+ var $prevNav;
+
+ var helpers = this;
+ $headings.each(function(i, el) {
+ var $newNav = helpers.generateNavItem(el);
+ var navLevel = helpers.getNavLevel(el);
+
+ // determine the proper $context
+ if (navLevel === topLevel) {
+ // use top level
+ $context = $topContext;
+ } else if ($prevNav && $context === $topContext) {
+ // create a new level of the tree and switch to it
+ $context = helpers.createChildNavList($prevNav);
+ } // else use the current $context
+
+ $context.append($newNav);
+
+ $prevNav = $newNav;
+ });
+ },
+
+ parseOps: function(arg) {
+ var opts;
+ if (arg.jquery) {
+ opts = {
+ $nav: arg
+ };
+ } else {
+ opts = arg;
+ }
+ opts.$scope = opts.$scope || $(document.body);
+ return opts;
+ }
+ },
+
+ // accepts a jQuery object, or an options object
+ init: function(opts) {
+ opts = this.helpers.parseOps(opts);
+
+ // ensure that the data attribute is in place for styling
+ opts.$nav.attr('data-toggle', 'toc');
+
+ var $topContext = this.helpers.createChildNavList(opts.$nav);
+ var topLevel = this.helpers.getTopLevel(opts.$scope);
+ var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
+ this.helpers.populateNav($topContext, topLevel, $headings);
+ }
+ };
+
+ $(function() {
+ $('nav[data-toggle="toc"]').each(function(i, el) {
+ var $nav = $(el);
+ Toc.init($nav);
+ });
+ });
+})();
diff --git a/docs/index.html b/docs/index.html
index c4f228a..c0f4417 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -5,241 +5,243 @@
-Tidy Verbs for Fast Data Operations by Reference • tidyft
+Fast and Memory Efficient Data Operations in Tidy Syntax • tidyft
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-Overview
-tidyft is an extension of data.table. Using modification by reference whenever possible, this toolkit is designed for big data analysis in high-performance desktop or laptop computers. The syntax of the package is similar or identical to tidyverse. It is user friendly, memory efficient and time saving. For more information, check its ancestor package tidyfst.
-This design is best for big data manipulation on out of memory data using facilities provided by fst. In such ways, you can handle the most quantity of data in the least time and space on your computer.
-
-
-
-
-Example
-This is a basic example which shows you how to solve a common problem:
-library(tidyft)
-
-# get first 5 rows of iris
-as.data.table(iris)[1:5] -> a
-#show
-a
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.9 3.0 1.4 0.2 setosa
-#> 3: 4.7 3.2 1.3 0.2 setosa
-#> 4: 4.6 3.1 1.5 0.2 setosa
-#> 5: 5.0 3.6 1.4 0.2 setosa
-
-# if you select
-a %>% select(1:3)
-#> Sepal.Length Sepal.Width Petal.Length
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4
-
-# you lose the unselected columns forever
-a
-#> Sepal.Length Sepal.Width Petal.Length
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4
-If you still want to keep the original data, use copy() to make a copy beforehand.
-
-
-
-Tutorial
-See vignettes.
-
-
-
-Performance
-
-
-rm(list = ls())
-
-library(profvis)
-library(dplyr)
-library(tidyft)
-as.data.frame(starwars) -> starwars
-starwars[sample.int(1:nrow(starwars),1e6,replace = T),] -> starwars
-copy(starwars) -> dat1
-copy(starwars) -> dat2
-copy(starwars) -> dat3
-
-profvis({
- dat1 %>%
- dplyr::as_tibble() %>%
- dplyr::select(name, dplyr::ends_with("color")) %>%
- dplyr::arrange(hair_color,skin_color,eye_color) -> a
-
- setorder(setDT(dat2)[,.SD,.SDcols = patterns("name|color$")],
- hair_color,skin_color,eye_color) -> b
-
- dat3 %>%
- tidyft::setDT() %>%
- tidyft::select("name|color$") %>%
- tidyft::arrange(hair_color,skin_color,eye_color) -> c
-
-
-})
-
-all.equal(a,b)
-#> [1] TRUE
-all.equal(b,c)
-#> [1] TRUE
-
-
-
-
-
-
-
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
diff --git a/docs/pkgdown.css b/docs/pkgdown.css
index 9145958..80ea5b8 100644
--- a/docs/pkgdown.css
+++ b/docs/pkgdown.css
@@ -17,6 +17,10 @@ html, body {
height: 100%;
}
+body {
+ position: relative;
+}
+
body > .container {
display: flex;
height: 100%;
@@ -52,8 +56,10 @@ img.icon {
float: right;
}
-img {
+/* Ensure in-page images don't run outside their container */
+.contents img {
max-width: 100%;
+ height: auto;
}
/* Fix bug in bootstrap (only seen in firefox) */
@@ -67,14 +73,17 @@ summary {
margin-top: calc(-60px + 1em);
}
+dd {
+ margin-left: 3em;
+}
+
/* Section anchors ---------------------------------*/
a.anchor {
- margin-left: -30px;
- display:inline-block;
- width: 30px;
- height: 30px;
- visibility: hidden;
+ display: none;
+ margin-left: 5px;
+ width: 20px;
+ height: 20px;
background-image: url(./link.svg);
background-repeat: no-repeat;
@@ -82,17 +91,15 @@ a.anchor {
background-position: center center;
}
-.hasAnchor:hover a.anchor {
- visibility: visible;
+h1:hover .anchor,
+h2:hover .anchor,
+h3:hover .anchor,
+h4:hover .anchor,
+h5:hover .anchor,
+h6:hover .anchor {
+ display: inline-block;
}
-@media (max-width: 767px) {
- .hasAnchor:hover a.anchor {
- visibility: hidden;
- }
-}
-
-
/* Fixes for fixed navbar --------------------------*/
.contents h1, .contents h2, .contents h3, .contents h4 {
@@ -100,29 +107,132 @@ a.anchor {
margin-top: -40px;
}
+/* Navbar submenu --------------------------*/
+
+.dropdown-submenu {
+ position: relative;
+}
+
+.dropdown-submenu>.dropdown-menu {
+ top: 0;
+ left: 100%;
+ margin-top: -6px;
+ margin-left: -1px;
+ border-radius: 0 6px 6px 6px;
+}
+
+.dropdown-submenu:hover>.dropdown-menu {
+ display: block;
+}
+
+.dropdown-submenu>a:after {
+ display: block;
+ content: " ";
+ float: right;
+ width: 0;
+ height: 0;
+ border-color: transparent;
+ border-style: solid;
+ border-width: 5px 0 5px 5px;
+ border-left-color: #cccccc;
+ margin-top: 5px;
+ margin-right: -10px;
+}
+
+.dropdown-submenu:hover>a:after {
+ border-left-color: #ffffff;
+}
+
+.dropdown-submenu.pull-left {
+ float: none;
+}
+
+.dropdown-submenu.pull-left>.dropdown-menu {
+ left: -100%;
+ margin-left: 10px;
+ border-radius: 6px 0 6px 6px;
+}
+
/* Sidebar --------------------------*/
-#sidebar {
+#pkgdown-sidebar {
margin-top: 30px;
position: -webkit-sticky;
position: sticky;
top: 70px;
}
-#sidebar h2 {
+
+#pkgdown-sidebar h2 {
font-size: 1.5em;
margin-top: 1em;
}
-#sidebar h2:first-child {
+#pkgdown-sidebar h2:first-child {
margin-top: 0;
}
-#sidebar .list-unstyled li {
+#pkgdown-sidebar .list-unstyled li {
margin-bottom: 0.5em;
}
+/* bootstrap-toc tweaks ------------------------------------------------------*/
+
+/* All levels of nav */
+
+nav[data-toggle='toc'] .nav > li > a {
+ padding: 4px 20px 4px 6px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+}
+
+nav[data-toggle='toc'] .nav > li > a:hover,
+nav[data-toggle='toc'] .nav > li > a:focus {
+ padding-left: 5px;
+ color: inherit;
+ border-left: 1px solid #878787;
+}
+
+nav[data-toggle='toc'] .nav > .active > a,
+nav[data-toggle='toc'] .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav > .active:focus > a {
+ padding-left: 5px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+ border-left: 2px solid #878787;
+}
+
+/* Nav: second level (shown on .active) */
+
+nav[data-toggle='toc'] .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a {
+ padding-left: 16px;
+ font-size: 1.35rem;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a:hover,
+nav[data-toggle='toc'] .nav .nav > li > a:focus {
+ padding-left: 15px;
+}
+
+nav[data-toggle='toc'] .nav .nav > .active > a,
+nav[data-toggle='toc'] .nav .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav .nav > .active:focus > a {
+ padding-left: 15px;
+ font-weight: 500;
+ font-size: 1.35rem;
+}
+
+/* orcid ------------------------------------------------------------------- */
+
.orcid {
- height: 16px;
+ font-size: 16px;
+ color: #A6CE39;
/* margins are required by official ORCID trademark and display guidelines */
margin-left:4px;
margin-right:4px;
@@ -133,14 +243,14 @@ a.anchor {
.ref-index th {font-weight: normal;}
-.ref-index td {vertical-align: top;}
+.ref-index td {vertical-align: top; min-width: 100px}
.ref-index .icon {width: 40px;}
.ref-index .alias {width: 40%;}
.ref-index-icons .alias {width: calc(40% - 40px);}
.ref-index .title {width: 60%;}
.ref-arguments th {text-align: right; padding-right: 10px;}
-.ref-arguments th, .ref-arguments td {vertical-align: top;}
+.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
.ref-arguments .name {width: 20%;}
.ref-arguments .desc {width: 80%;}
@@ -153,31 +263,26 @@ table {
/* Syntax highlighting ---------------------------------------------------- */
-pre {
- word-wrap: normal;
- word-break: normal;
- border: 1px solid #eee;
-}
-
-pre, code {
+pre, code, pre code {
background-color: #f8f8f8;
color: #333;
}
+pre, pre code {
+ white-space: pre-wrap;
+ word-break: break-all;
+ overflow-wrap: break-word;
+}
-pre code {
- overflow: auto;
- word-wrap: normal;
- white-space: pre;
+pre {
+ border: 1px solid #eee;
}
-pre .img {
+pre .img, pre .r-plt {
margin: 5px 0;
}
-pre .img img {
+pre .img img, pre .r-plt img {
background-color: #fff;
- display: block;
- height: auto;
}
code a, pre a {
@@ -194,9 +299,8 @@ a.sourceLine:hover {
.kw {color: #264D66;} /* keyword */
.co {color: #888888;} /* comment */
-.message { color: black; font-weight: bolder;}
-.error { color: orange; font-weight: bolder;}
-.warning { color: #6A0366; font-weight: bolder;}
+.error {font-weight: bolder;}
+.warning {font-weight: bolder;}
/* Clipboard --------------------------*/
@@ -254,3 +358,27 @@ mark {
content: "";
}
}
+
+/* Section anchors ---------------------------------
+ Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
+*/
+
+div.csl-bib-body { }
+div.csl-entry {
+ clear: both;
+}
+.hanging-indent div.csl-entry {
+ margin-left:2em;
+ text-indent:-2em;
+}
+div.csl-left-margin {
+ min-width:2em;
+ float:left;
+}
+div.csl-right-inline {
+ margin-left:2em;
+ padding-left:1em;
+}
+div.csl-indent {
+ margin-left: 2em;
+}
diff --git a/docs/pkgdown.js b/docs/pkgdown.js
index 087a762..6f0eee4 100644
--- a/docs/pkgdown.js
+++ b/docs/pkgdown.js
@@ -9,11 +9,6 @@
$('body').css('padding-top', $('.navbar').height() + 10);
});
- $('body').scrollspy({
- target: '#sidebar',
- offset: 60
- });
-
$('[data-toggle="tooltip"]').tooltip();
var cur_path = paths(location.pathname);
@@ -85,7 +80,7 @@
$(document).ready(function() {
var copyButton = "";
- $(".examples, div.sourceCode").addClass("hasCopyButton");
+ $("div.sourceCode").addClass("hasCopyButton");
// Insert copy buttons:
$(copyButton).prependTo(".hasCopyButton");
@@ -96,7 +91,7 @@
// Initialize clipboard:
var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', {
text: function(trigger) {
- return trigger.parentNode.textContent;
+ return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, "");
}
});
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index e93a3fb..eb9bb62 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -1,6 +1,6 @@
-pandoc: 2.7.2
-pkgdown: 1.4.1
+pandoc: 3.1.11
+pkgdown: 2.1.0
pkgdown_sha: ~
articles:
Introduction: Introduction.html
-
+last_built: 2024-09-22T01:35Z
diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png
new file mode 100644
index 0000000000000000000000000000000000000000..17a358060aed2a86950757bbd25c6f92c08c458f
GIT binary patch
literal 1011
zcmeAS@N?(olHy`uVBq!ia0y~yV0-|=9Be?5+AI5}0x7m6Z+90U4Fo@(ch>_c&H|6f
zVg?3oArNM~bhqvg0|WD9PZ!6KiaBo&GBN^{G%5UFpXcEKVvd5*5Eu=C0SJK)8A6*F
U7`aXvEC5;V>FVdQ&MBb@00SN#Z2$lO
literal 0
HcmV?d00001
diff --git a/docs/reference/arrange.html b/docs/reference/arrange.html
index 004dadc..ec794b1 100644
--- a/docs/reference/arrange.html
+++ b/docs/reference/arrange.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Arrange entries in data.frame — arrange • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Arrange entries in data.frame — arrange • tidyft
-
-
+
-
-
-
-
-
-
-
+
@@ -134,128 +59,132 @@ Arrange entries in data.frame
Analogous function for arrange in dplyr.
- arrange(.data, ..., cols = NULL, order = 1L)
-
- Arguments
-
-
- .data
- data.frame
-
- ...
- Arrange by what group? Minus symbol means arrange by
-descending order.
-
- cols
- For set_arrange only.
+
+ arrange(.data, ..., cols = NULL, order = 1L)
+
+
+
-
- order
- For set_arrange only. An integer vector with only possible
-values of 1 and -1, corresponding to ascending and descending order.
-Defaults to 1.
-
+If present, override .... Defaults to NULL.
- Value
- A data.table
- Details
+order
+For set_arrange only. An integer vector with only possible
+values of 1 and -1, corresponding to ascending and descending order.
+Defaults to 1.
Value
+ A data.table
+
+
+ Details
Once arranged, the order of entries would be changed forever.
- See also
-
-
-
- Examples
- #> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 4.3 3.0 1.1 0.1 setosa
-#> 2: 4.4 2.9 1.4 0.2 setosa
-#> 3: 4.4 3.0 1.3 0.2 setosa
-#> 4: 4.4 3.2 1.3 0.2 setosa
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 7.7 3.8 6.7 2.2 virginica
-#> 147: 7.7 2.6 6.9 2.3 virginica
-#> 148: 7.7 2.8 6.7 2.0 virginica
-#> 149: 7.7 3.0 6.1 2.3 virginica
-#> 150: 7.9 3.8 6.4 2.0 virginicaa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 4.3 3.0 1.1 0.1 setosa
-#> 2: 4.4 2.9 1.4 0.2 setosa
-#> 3: 4.4 3.0 1.3 0.2 setosa
-#> 4: 4.4 3.2 1.3 0.2 setosa
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 7.7 3.8 6.7 2.2 virginica
-#> 147: 7.7 2.6 6.9 2.3 virginica
-#> 148: 7.7 2.8 6.7 2.0 virginica
-#> 149: 7.7 3.0 6.1 2.3 virginica
-#> 150: 7.9 3.8 6.4 2.0 virginica#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.0 2.0 3.5 1.0 versicolor
-#> 2: 6.0 2.2 4.0 1.0 versicolor
-#> 3: 6.2 2.2 4.5 1.5 versicolor
-#> 4: 6.0 2.2 5.0 1.5 virginica
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 5.4 3.9 1.7 0.4 setosa
-#> 147: 5.8 4.0 1.2 0.2 setosa
-#> 148: 5.2 4.1 1.5 0.1 setosa
-#> 149: 5.5 4.2 1.4 0.2 setosa
-#> 150: 5.7 4.4 1.5 0.4 setosaa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.0 2.0 3.5 1.0 versicolor
-#> 2: 6.0 2.2 4.0 1.0 versicolor
-#> 3: 6.2 2.2 4.5 1.5 versicolor
-#> 4: 6.0 2.2 5.0 1.5 virginica
-#> 5: 4.5 2.3 1.3 0.3 setosa
-#> ---
-#> 146: 5.4 3.9 1.7 0.4 setosa
-#> 147: 5.8 4.0 1.2 0.2 setosa
-#> 148: 5.2 4.1 1.5 0.1 setosa
-#> 149: 5.5 4.2 1.4 0.2 setosa
-#> 150: 5.7 4.4 1.5 0.4 setosa
-
-
-
+
+
+ Examples
+
+a = as.data.table(iris)
+a %>% arrange(Sepal.Length)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 4.3 3.0 1.1 0.1 setosa
+#> 2: 4.4 2.9 1.4 0.2 setosa
+#> 3: 4.4 3.0 1.3 0.2 setosa
+#> 4: 4.4 3.2 1.3 0.2 setosa
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 7.7 3.8 6.7 2.2 virginica
+#> 147: 7.7 2.6 6.9 2.3 virginica
+#> 148: 7.7 2.8 6.7 2.0 virginica
+#> 149: 7.7 3.0 6.1 2.3 virginica
+#> 150: 7.9 3.8 6.4 2.0 virginica
+a
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 4.3 3.0 1.1 0.1 setosa
+#> 2: 4.4 2.9 1.4 0.2 setosa
+#> 3: 4.4 3.0 1.3 0.2 setosa
+#> 4: 4.4 3.2 1.3 0.2 setosa
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 7.7 3.8 6.7 2.2 virginica
+#> 147: 7.7 2.6 6.9 2.3 virginica
+#> 148: 7.7 2.8 6.7 2.0 virginica
+#> 149: 7.7 3.0 6.1 2.3 virginica
+#> 150: 7.9 3.8 6.4 2.0 virginica
+a %>% arrange(cols = c("Sepal.Width","Petal.Length"))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.0 2.0 3.5 1.0 versicolor
+#> 2: 6.0 2.2 4.0 1.0 versicolor
+#> 3: 6.2 2.2 4.5 1.5 versicolor
+#> 4: 6.0 2.2 5.0 1.5 virginica
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 5.4 3.9 1.7 0.4 setosa
+#> 147: 5.8 4.0 1.2 0.2 setosa
+#> 148: 5.2 4.1 1.5 0.1 setosa
+#> 149: 5.5 4.2 1.4 0.2 setosa
+#> 150: 5.7 4.4 1.5 0.4 setosa
+a
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.0 2.0 3.5 1.0 versicolor
+#> 2: 6.0 2.2 4.0 1.0 versicolor
+#> 3: 6.2 2.2 4.5 1.5 versicolor
+#> 4: 6.0 2.2 5.0 1.5 virginica
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 5.4 3.9 1.7 0.4 setosa
+#> 147: 5.8 4.0 1.2 0.2 setosa
+#> 148: 5.2 4.1 1.5 0.1 setosa
+#> 149: 5.5 4.2 1.4 0.2 setosa
+#> 150: 5.7 4.4 1.5 0.4 setosa
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/as_fst.html b/docs/reference/as_fst.html
index 300e5ec..c5acdd9 100644
--- a/docs/reference/as_fst.html
+++ b/docs/reference/as_fst.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Save a data.frame as a fst table — as_fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Save a data.frame as a fst table — as_fst • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -136,72 +61,70 @@ Save a data.frame as a fst table
and then parse it back as a fst table (class name is "fst_table").
- as_fst(.data)
+
+ as_fst(.data)
+
- Arguments
-
-
- .data
- A data.frame
-
+
+ Arguments
- Value
- An object of class fst_table
+- .data
+A data.frame
Examples
-
-# \donttest{
- iris %>%
- as_fst() -> iris_fst
- iris_fst#> <fst file>
-#> 150 rows, 5 columns (.a5445415a58.fst)
-#>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <double> <double> <double> <double> <factor>
-#> 1 5.1 3.5 1.4 0.2 setosa
-#> 2 4.9 3.0 1.4 0.2 setosa
-#> 3 4.7 3.2 1.3 0.2 setosa
-#> 4 4.6 3.1 1.5 0.2 setosa
-#> 5 5.0 3.6 1.4 0.2 setosa
-#> -- -- -- -- -- --
-#> 146 6.7 3.0 5.2 2.3 virginica
-#> 147 6.3 2.5 5.0 1.9 virginica
-#> 148 6.5 3.0 5.2 2.0 virginica
-#> 149 6.2 3.4 5.4 2.3 virginica
-#> 150 5.9 3.0 5.1 1.8 virginica# }
-
-
-
+
+ Value
+ An object of class fst_table
+
+
+ Examples
+
+# \donttest{
+ iris %>%
+ as_fst() -> iris_fst
+ iris_fst
+#> <fst file>
+#> 150 rows, 5 columns (.27606c92540e.fst)
+#>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <double> <double> <double> <double> <factor>
+#> 1 5.1 3.5 1.4 0.2 setosa
+#> 2 4.9 3.0 1.4 0.2 setosa
+#> 3 4.7 3.2 1.3 0.2 setosa
+#> 4 4.6 3.1 1.5 0.2 setosa
+#> 5 5.0 3.6 1.4 0.2 setosa
+#> -- -- -- -- -- --
+#> 146 6.7 3.0 5.2 2.3 virginica
+#> 147 6.3 2.5 5.0 1.9 virginica
+#> 148 6.5 3.0 5.2 2.0 virginica
+#> 149 6.2 3.4 5.4 2.3 virginica
+#> 150 5.9 3.0 5.1 1.8 virginica
+# }
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/complete.html b/docs/reference/complete.html
index 2dce3ea..0d9cfee 100644
--- a/docs/reference/complete.html
+++ b/docs/reference/complete.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Complete a data frame with missing combinations of data — complete • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Complete a data frame with missing combinations of data — complete • tidyft
-
+
-
-
-
-
-
-
-
-
+
Complete a data frame with missing combinations of data
- Source: R/complete.R
+ Source: R/complete.R
complete.Rd
@@ -136,150 +61,158 @@ Complete a data frame with missing combinations of data
Analogous function for complete function in tidyr.
- complete(.data, ..., fill = NA)
+
+ complete(.data, ..., fill = NA)
+
+
+
+ Arguments
- Arguments
-
-
- .data
- data.frame
-
- ...
- Specification of columns to expand.The selection of columns is
-supported by the flexible select_dt.
+
+
- .data
+data.frame
- ...
+Specification of columns to expand.The selection of columns is
+supported by the flexible select_dt.
To find all unique combinations of provided columns, including those not found in the data,
supply each variable as a separate argument. But the two modes (select the
needed columns and fill outside values) could not be mixed,
-find more details in examples.
-
- fill
- Atomic value to fill into the missing cell, default uses NA.
-
+find more details in examples.
- Value
- data.table
- Details
+fill
+Atomic value to fill into the missing cell, default uses NA.
Value
+ data.table
+
+
+ Details
When the provided columns with addtion data are of different length,
all the unique combinations would be returned. This operation should be used
only on unique entries, and it will always returned the unique entries.
If you supply fill parameter, these values will also replace existing explicit missing values in the data set.
- See also
-
-
-
- Examples
- df <- data.table(
- group = c(1:2, 1),
- item_id = c(1:2, 2),
- item_name = c("a", "b", "b"),
- value1 = 1:3,
- value2 = 4:6
-)
-
-df %>% complete(item_id,item_name)#> Key: <item_id, item_name>
-#> item_id item_name group value1 value2
-#> <num> <char> <num> <int> <int>
-#> 1: 1 a 1 1 4
-#> 2: 1 b NA NA NA
-#> 3: 2 a NA NA NA
-#> 4: 2 b 2 2 5
-#> 5: 2 b 1 3 6df %>% complete(item_id,item_name,fill = 0)#> Key: <item_id, item_name>
-#> item_id item_name group value1 value2
-#> <num> <char> <num> <int> <int>
-#> 1: 1 a 1 1 4
-#> 2: 1 b 0 0 0
-#> 3: 2 a 0 0 0
-#> 4: 2 b 2 2 5
-#> 5: 2 b 1 3 6df %>% complete("item")#> Key: <item_id, item_name>
-#> item_id item_name group value1 value2
-#> <num> <char> <num> <int> <int>
-#> 1: 1 a 1 1 4
-#> 2: 1 b NA NA NA
-#> 3: 2 a NA NA NA
-#> 4: 2 b 2 2 5
-#> 5: 2 b 1 3 6df %>% complete(item_id=1:3)#> Key: <item_id>
-#> item_id group item_name value1 value2
-#> <int> <num> <char> <int> <int>
-#> 1: 1 1 a 1 4
-#> 2: 2 2 b 2 5
-#> 3: 2 1 b 3 6
-#> 4: 3 NA <NA> NA NAdf %>% complete(item_id=1:3,group=1:2)#> Key: <item_id, group>
-#> item_id group item_name value1 value2
-#> <int> <int> <char> <int> <int>
-#> 1: 1 1 a 1 4
-#> 2: 1 2 <NA> NA NA
-#> 3: 2 1 b 3 6
-#> 4: 2 2 b 2 5
-#> 5: 3 1 <NA> NA NA
-#> 6: 3 2 <NA> NA NA#> Key: <item_id, group, item_name>
-#> item_id group item_name value1 value2
-#> <int> <int> <char> <int> <int>
-#> 1: 1 1 a 1 4
-#> 2: 1 1 b NA NA
-#> 3: 1 1 c NA NA
-#> 4: 1 2 a NA NA
-#> 5: 1 2 b NA NA
-#> 6: 1 2 c NA NA
-#> 7: 1 3 a NA NA
-#> 8: 1 3 b NA NA
-#> 9: 1 3 c NA NA
-#> 10: 2 1 a NA NA
-#> 11: 2 1 b 3 6
-#> 12: 2 1 c NA NA
-#> 13: 2 2 a NA NA
-#> 14: 2 2 b 2 5
-#> 15: 2 2 c NA NA
-#> 16: 2 3 a NA NA
-#> 17: 2 3 b NA NA
-#> 18: 2 3 c NA NA
-#> 19: 3 1 a NA NA
-#> 20: 3 1 b NA NA
-#> 21: 3 1 c NA NA
-#> 22: 3 2 a NA NA
-#> 23: 3 2 b NA NA
-#> 24: 3 2 c NA NA
-#> 25: 3 3 a NA NA
-#> 26: 3 3 b NA NA
-#> 27: 3 3 c NA NA
-#> item_id group item_name value1 value2
-
-
-
+
+ See also
+
+
+
+ Examples
+ df <- data.table(
+ group = c(1:2, 1),
+ item_id = c(1:2, 2),
+ item_name = c("a", "b", "b"),
+ value1 = 1:3,
+ value2 = 4:6
+)
+
+df %>% complete(item_id,item_name)
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b NA NA NA
+#> 3: 2 a NA NA NA
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete(item_id,item_name,fill = 0)
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b 0 0 0
+#> 3: 2 a 0 0 0
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete("item")
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b NA NA NA
+#> 3: 2 a NA NA NA
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete(item_id=1:3)
+#> Key: <item_id>
+#> item_id group item_name value1 value2
+#> <int> <num> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 2 2 b 2 5
+#> 3: 2 1 b 3 6
+#> 4: 3 NA <NA> NA NA
+df %>% complete(item_id=1:3,group=1:2)
+#> Key: <item_id, group>
+#> item_id group item_name value1 value2
+#> <int> <int> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 1 2 <NA> NA NA
+#> 3: 2 1 b 3 6
+#> 4: 2 2 b 2 5
+#> 5: 3 1 <NA> NA NA
+#> 6: 3 2 <NA> NA NA
+df %>% complete(item_id=1:3,group=1:3,item_name=c("a","b","c"))
+#> Key: <item_id, group, item_name>
+#> item_id group item_name value1 value2
+#> <int> <int> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 1 1 b NA NA
+#> 3: 1 1 c NA NA
+#> 4: 1 2 a NA NA
+#> 5: 1 2 b NA NA
+#> 6: 1 2 c NA NA
+#> 7: 1 3 a NA NA
+#> 8: 1 3 b NA NA
+#> 9: 1 3 c NA NA
+#> 10: 2 1 a NA NA
+#> 11: 2 1 b 3 6
+#> 12: 2 1 c NA NA
+#> 13: 2 2 a NA NA
+#> 14: 2 2 b 2 5
+#> 15: 2 2 c NA NA
+#> 16: 2 3 a NA NA
+#> 17: 2 3 b NA NA
+#> 18: 2 3 c NA NA
+#> 19: 3 1 a NA NA
+#> 20: 3 1 b NA NA
+#> 21: 3 1 c NA NA
+#> 22: 3 2 a NA NA
+#> 23: 3 2 b NA NA
+#> 24: 3 2 c NA NA
+#> 25: 3 3 a NA NA
+#> 26: 3 3 b NA NA
+#> 27: 3 3 c NA NA
+#> item_id group item_name value1 value2
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/count.html b/docs/reference/count.html
index 895be5a..0f6fe7e 100644
--- a/docs/reference/count.html
+++ b/docs/reference/count.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Count observations by group — count • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Count observations by group — count • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,135 +59,141 @@ Count observations by group
Analogous function for count and add_count in dplyr.
- count(.data, ..., sort = FALSE, name = "n")
-
-add_count(.data, ..., name = "n")
-
- Arguments
-
-
- .data
- data.table
-
- ...
- variables to group by.
-
- sort
- logical. If TRUE result will be sorted in desending order by resulting variable.
-
- name
- character. Name of resulting variable. Default uses "n".
-
-
- Value
+
+ count(.data, ..., sort = FALSE, name = "n")
+
+add_count(.data, ..., name = "n")
+
+
+
+ Arguments
- data.table
- Examples
- #> cyl n
-#> <num> <int>
-#> 1: 6 7
-#> 2: 4 11
-#> 3: 8 14count(a,cyl,sort = TRUE)#> cyl n
-#> <num> <int>
-#> 1: 8 14
-#> 2: 4 11
-#> 3: 6 7a#> mpg cyl disp hp drat wt qsec vs am gear carb
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
-#> 2: 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
-#> 3: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
-#> 4: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
-#> 5: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
-#> 6: 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1
-#> 7: 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4
-#> 8: 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
-#> 9: 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
-#> 10: 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4
-#> 11: 17.8 6 167.6 123 3.92 3.440 18.90 1 0 4 4
-#> 12: 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3
-#> 13: 17.3 8 275.8 180 3.07 3.730 17.60 0 0 3 3
-#> 14: 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3
-#> 15: 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4
-#> 16: 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4
-#> 17: 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4
-#> 18: 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1
-#> 19: 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2
-#> 20: 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1
-#> 21: 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1
-#> 22: 15.5 8 318.0 150 2.76 3.520 16.87 0 0 3 2
-#> 23: 15.2 8 304.0 150 3.15 3.435 17.30 0 0 3 2
-#> 24: 13.3 8 350.0 245 3.73 3.840 15.41 0 0 3 4
-#> 25: 19.2 8 400.0 175 3.08 3.845 17.05 0 0 3 2
-#> 26: 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1
-#> 27: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
-#> 28: 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2
-#> 29: 15.8 8 351.0 264 4.22 3.170 14.50 0 1 5 4
-#> 30: 19.7 6 145.0 175 3.62 2.770 15.50 0 1 5 6
-#> 31: 15.0 8 301.0 335 3.54 3.570 14.60 0 1 5 8
-#> 32: 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2
-#> mpg cyl disp hp drat wt qsec vs am gear carb#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
-#> <num> <num> <num> <num> <fctr> <int>
-#> 1: 5.1 3.5 1.4 0.2 setosa 50
-#> 2: 4.9 3.0 1.4 0.2 setosa 50
-#> 3: 4.7 3.2 1.3 0.2 setosa 50
-#> 4: 4.6 3.1 1.5 0.2 setosa 50
-#> 5: 5.0 3.6 1.4 0.2 setosa 50
-#> ---
-#> 146: 6.7 3.0 5.2 2.3 virginica 50
-#> 147: 6.3 2.5 5.0 1.9 virginica 50
-#> 148: 6.5 3.0 5.2 2.0 virginica 50
-#> 149: 6.2 3.4 5.4 2.3 virginica 50
-#> 150: 5.9 3.0 5.1 1.8 virginica 50b#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
-#> <num> <num> <num> <num> <fctr> <int>
-#> 1: 5.1 3.5 1.4 0.2 setosa 50
-#> 2: 4.9 3.0 1.4 0.2 setosa 50
-#> 3: 4.7 3.2 1.3 0.2 setosa 50
-#> 4: 4.6 3.1 1.5 0.2 setosa 50
-#> 5: 5.0 3.6 1.4 0.2 setosa 50
-#> ---
-#> 146: 6.7 3.0 5.2 2.3 virginica 50
-#> 147: 6.3 2.5 5.0 1.9 virginica 50
-#> 148: 6.5 3.0 5.2 2.0 virginica 50
-#> 149: 6.2 3.4 5.4 2.3 virginica 50
-#> 150: 5.9 3.0 5.1 1.8 virginica 50
-
-
+
+ Value
+ data.table
+
+
+
+ Examples
+ a = as.data.table(mtcars)
+count(a,cyl)
+#> cyl n
+#> <num> <int>
+#> 1: 6 7
+#> 2: 4 11
+#> 3: 8 14
+count(a,cyl,sort = TRUE)
+#> cyl n
+#> <num> <int>
+#> 1: 8 14
+#> 2: 4 11
+#> 3: 6 7
+a
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
+#> 2: 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
+#> 3: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
+#> 4: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
+#> 5: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
+#> 6: 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1
+#> 7: 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4
+#> 8: 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
+#> 9: 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
+#> 10: 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4
+#> 11: 17.8 6 167.6 123 3.92 3.440 18.90 1 0 4 4
+#> 12: 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3
+#> 13: 17.3 8 275.8 180 3.07 3.730 17.60 0 0 3 3
+#> 14: 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3
+#> 15: 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4
+#> 16: 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4
+#> 17: 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4
+#> 18: 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1
+#> 19: 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2
+#> 20: 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1
+#> 21: 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1
+#> 22: 15.5 8 318.0 150 2.76 3.520 16.87 0 0 3 2
+#> 23: 15.2 8 304.0 150 3.15 3.435 17.30 0 0 3 2
+#> 24: 13.3 8 350.0 245 3.73 3.840 15.41 0 0 3 4
+#> 25: 19.2 8 400.0 175 3.08 3.845 17.05 0 0 3 2
+#> 26: 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1
+#> 27: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
+#> 28: 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2
+#> 29: 15.8 8 351.0 264 4.22 3.170 14.50 0 1 5 4
+#> 30: 19.7 6 145.0 175 3.62 2.770 15.50 0 1 5 6
+#> 31: 15.0 8 301.0 335 3.54 3.570 14.60 0 1 5 8
+#> 32: 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+
+b = as.data.table(iris)
+b %>% add_count(Species,name = "N")
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
+#> <num> <num> <num> <num> <fctr> <int>
+#> 1: 5.1 3.5 1.4 0.2 setosa 50
+#> 2: 4.9 3.0 1.4 0.2 setosa 50
+#> 3: 4.7 3.2 1.3 0.2 setosa 50
+#> 4: 4.6 3.1 1.5 0.2 setosa 50
+#> 5: 5.0 3.6 1.4 0.2 setosa 50
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica 50
+#> 147: 6.3 2.5 5.0 1.9 virginica 50
+#> 148: 6.5 3.0 5.2 2.0 virginica 50
+#> 149: 6.2 3.4 5.4 2.3 virginica 50
+#> 150: 5.9 3.0 5.1 1.8 virginica 50
+b
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
+#> <num> <num> <num> <num> <fctr> <int>
+#> 1: 5.1 3.5 1.4 0.2 setosa 50
+#> 2: 4.9 3.0 1.4 0.2 setosa 50
+#> 3: 4.7 3.2 1.3 0.2 setosa 50
+#> 4: 4.6 3.1 1.5 0.2 setosa 50
+#> 5: 5.0 3.6 1.4 0.2 setosa 50
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica 50
+#> 147: 6.3 2.5 5.0 1.9 virginica 50
+#> 148: 6.5 3.0 5.2 2.0 virginica 50
+#> 149: 6.2 3.4 5.4 2.3 virginica 50
+#> 150: 5.9 3.0 5.1 1.8 virginica 50
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/cummean.html b/docs/reference/cummean.html
index 5d73212..bd15ddf 100644
--- a/docs/reference/cummean.html
+++ b/docs/reference/cummean.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Cumulative mean — cummean • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Cumulative mean — cummean • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,54 +59,52 @@ Cumulative mean
Returns a vector whose elements are the cumulative mean of the elements of the argument.
- cummean(x)
+
+ cummean(x)
+
- Arguments
-
-
- x
- a numeric or complex object,
-or an object that can be coerced to one of these.
-
+
-
+
+ Value
+ A numeric vector
+
+
+ Examples
+ cummean(1:10)
+#> [1] 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0 5.5
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/distinct.html b/docs/reference/distinct.html
index 2ef71bc..f89f37f 100644
--- a/docs/reference/distinct.html
+++ b/docs/reference/distinct.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Select distinct/unique rows in data.table — distinct • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Select distinct/unique rows in data.table — distinct • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,83 +59,83 @@ Select distinct/unique rows in data.table
Analogous function for distinct in dplyr
- distinct(.data, ..., .keep_all = FALSE)
-
- Arguments
-
-
- .data
- data.table
-
- ...
- Optional variables to use when determining uniqueness.
+
+ distinct(.data, ..., .keep_all = FALSE)
+
+
+
-
- .keep_all
- If TRUE, keep all variables in data.table. If a combination of ... is not distinct,
-this keeps the first row of values.
-
+If omitted, will use all variables.
+
- Value
+.keep_all
+If TRUE, keep all variables in data.table. If a combination of ... is not distinct,
+this keeps the first row of values.
Value
data.table
- See also
-
-
-
- Examples
- #> Species
-#> <fctr>
-#> 1: setosa
-#> 2: versicolor
-#> 3: virginica b %>% distinct(cyl,vs,.keep_all = TRUE)#> mpg cyl disp hp drat wt qsec vs am gear carb
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
-#> 2: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
-#> 3: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
-#> 4: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
-#> 5: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
-
-
-
-
+
+ See also
+
+
+
+ Examples
+
+ a = as.data.table(iris)
+ b = as.data.table(mtcars)
+ a %>% distinct(Species)
+#> Species
+#> <fctr>
+#> 1: setosa
+#> 2: versicolor
+#> 3: virginica
+ b %>% distinct(cyl,vs,.keep_all = TRUE)
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
+#> 2: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
+#> 3: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
+#> 4: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
+#> 5: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
+
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/drop_delete_na.html b/docs/reference/drop_delete_na.html
index 3699b00..a05fd54 100644
--- a/docs/reference/drop_delete_na.html
+++ b/docs/reference/drop_delete_na.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Drop or delete data by rows or columns — drop_na • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Drop or delete data by rows or columns — drop_na • tidyft
-
+
-
-
-
-
-
-
-
-
+
Drop or delete data by rows or columns
- Source: R/drop_delete_na.R
+ Source: R/drop_delete_na.R
drop_delete_na.Rd
@@ -136,104 +61,114 @@ Drop or delete data by rows or columns
delete_na deletes rows or columns with too many NAs.
- drop_na(.data, ...)
-
-delete_na(.data, MARGIN, n)
-
- Arguments
-
-
- .data
- A data.table
-
- ...
- Colunms to be dropped or deleted.
-
- MARGIN
- 1 or 2. 1 for deleting rows, 2 for deleting columns.
-
- n
- If number (proportion) of NAs is larger than or equal to "n",
-the columns/rows would be deleted. When smaller than 1, use as proportion.
-When larger or equal to 1, use as number.
-
+
+ drop_na(.data, ...)
+
+delete_na(.data, MARGIN, n)
+
- Value
+
+ Arguments
- A data.table
- Examples
- #> x y z
-#> <num> <num> <lgcl>
-#> 1: 1 NA NA
-#> 2: 2 NA NA
-#> 3: NA 4 NA
-#> 4: 3 5 NAx %>% delete_na(2,0.75)#> x y
-#> <num> <num>
-#> 1: 1 NA
-#> 2: 2 NA
-#> 3: NA 4
-#> 4: 3 5#> x
-#> <num>
-#> 1: 1
-#> 2: 2
-#> 3: NA
-#> 4: 3#> Null data.table (0 rows and 0 cols)#> x
-#> <num>
-#> 1: 1
-#> 2: 2
-#> 3: NA
-#> 4: 3#> x y z
-#> <num> <num> <lgcl>
-#> 1: 3 5 NA#> x y z
-#> <num> <num> <lgcl>
-#> 1: 3 5 NA
-
-
-
-
+
+ Value
+ A data.table
+
+
+
+ Examples
+ x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 1 NA NA
+#> 2: 2 NA NA
+#> 3: NA 4 NA
+#> 4: 3 5 NA
+x %>% delete_na(2,0.75)
+#> x y
+#> <num> <num>
+#> 1: 1 NA
+#> 2: 2 NA
+#> 3: NA 4
+#> 4: 3 5
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,0.5)
+#> x
+#> <num>
+#> 1: 1
+#> 2: 2
+#> 3: NA
+#> 4: 3
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,0.24)
+#> Null data.table (0 rows and 0 cols)
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,2)
+#> x
+#> <num>
+#> 1: 1
+#> 2: 2
+#> 3: NA
+#> 4: 3
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(1,0.6)
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 3 5 NA
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(1,2)
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 3 5 NA
+
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/dummy.html b/docs/reference/dummy.html
index 9a1d3b6..617b998 100644
--- a/docs/reference/dummy.html
+++ b/docs/reference/dummy.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-Fast creation of dummy variables — dummy • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Fast creation of dummy variables — dummy • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -136,162 +61,166 @@ Fast creation of dummy variables
This function is useful for statistical analysis when you want binary columns rather than character columns.
- dummy(.data, ..., longname = TRUE)
+
+ dummy(.data, ..., longname = TRUE)
+
+
+
+ Arguments
- Arguments
-
-
- .data
- data.frame
-
- ...
- Columns you want to create dummy variables from.
-Very flexible, find in the examples.
-
- longname
- logical. Should the output column labeled with the
-original column name? Default uses TRUE.
-
- Value
+
+
+ Value
+ data.table
+
+
+ Details
If no columns provided, will return the original data frame.
This function is inspired by fastDummies package, but provides
-simple and precise usage, whereas fastDummies::dummy_cols provides more
+simple and precise usage, whereas fastDummies::dummy_cols provides more
features for statistical usage.
- See also
-
-
-
- Examples
- #> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species_setosa
-#> <num> <num> <num> <num> <num>
-#> 1: 4.3 3.0 1.1 0.1 1
-#> 2: 4.4 2.9 1.4 0.2 1
-#> 3: 4.4 3.0 1.3 0.2 1
-#> 4: 4.4 3.2 1.3 0.2 1
-#> 5: 4.5 2.3 1.3 0.3 1
-#> ---
-#> 146: 7.7 2.6 6.9 2.3 0
-#> 147: 7.7 2.8 6.7 2.0 0
-#> 148: 7.7 3.0 6.1 2.3 0
-#> 149: 7.7 3.8 6.7 2.2 0
-#> 150: 7.9 3.8 6.4 2.0 0
-#> Species_versicolor Species_virginica
-#> <num> <num>
-#> 1: 0 0
-#> 2: 0 0
-#> 3: 0 0
-#> 4: 0 0
-#> 5: 0 0
-#> ---
-#> 146: 0 1
-#> 147: 0 1
-#> 148: 0 1
-#> 149: 0 1
-#> 150: 0 1iris %>% dummy(Species,longname = FALSE)#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width setosa versicolor
-#> <num> <num> <num> <num> <num> <num>
-#> 1: 4.3 3.0 1.1 0.1 1 0
-#> 2: 4.4 2.9 1.4 0.2 1 0
-#> 3: 4.4 3.0 1.3 0.2 1 0
-#> 4: 4.4 3.2 1.3 0.2 1 0
-#> 5: 4.5 2.3 1.3 0.3 1 0
-#> ---
-#> 146: 7.7 2.6 6.9 2.3 0 0
-#> 147: 7.7 2.8 6.7 2.0 0 0
-#> 148: 7.7 3.0 6.1 2.3 0 0
-#> 149: 7.7 3.8 6.7 2.2 0 0
-#> 150: 7.9 3.8 6.4 2.0 0 0
-#> virginica
-#> <num>
-#> 1: 0
-#> 2: 0
-#> 3: 0
-#> 4: 0
-#> 5: 0
-#> ---
-#> 146: 1
-#> 147: 1
-#> 148: 1
-#> 149: 1
-#> 150: 1#> Key: <mpg, cyl, disp, hp, drat, wt, qsec, gear, carb, vs_0, vs_1>
-#> mpg cyl disp hp drat wt qsec gear carb vs_0 vs_1 am_0
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 18.1 6 225 105 2.76 3.460 20.22 3 1 0 1 1
-#> 2: 18.7 8 360 175 3.15 3.440 17.02 3 2 1 0 1
-#> 3: 21.0 6 160 110 3.90 2.620 16.46 4 4 1 0 0
-#> 4: 21.0 6 160 110 3.90 2.875 17.02 4 4 1 0 0
-#> 5: 21.4 6 258 110 3.08 3.215 19.44 3 1 0 1 1
-#> 6: 22.8 4 108 93 3.85 2.320 18.61 4 1 0 1 0
-#> am_1
-#> <num>
-#> 1: 0
-#> 2: 0
-#> 3: 1
-#> 4: 1
-#> 5: 0
-#> 6: 1#> Key: <mpg, disp, hp, drat, wt, qsec, vs, am, carb, cyl_4, cyl_6, cyl_8>
-#> mpg disp hp drat wt qsec vs am carb cyl_4 cyl_6 cyl_8
-#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
-#> 1: 18.1 225 105 2.76 3.460 20.22 1 0 1 0 1 0
-#> 2: 18.7 360 175 3.15 3.440 17.02 0 0 2 0 0 1
-#> 3: 21.0 160 110 3.90 2.620 16.46 0 1 4 0 1 0
-#> 4: 21.0 160 110 3.90 2.875 17.02 0 1 4 0 1 0
-#> 5: 21.4 258 110 3.08 3.215 19.44 1 0 1 0 1 0
-#> 6: 22.8 108 93 3.85 2.320 18.61 1 1 1 1 0 0
-#> gear_3 gear_4
-#> <num> <num>
-#> 1: 1 0
-#> 2: 1 0
-#> 3: 0 1
-#> 4: 0 1
-#> 5: 1 0
-#> 6: 0 1
-
-
-
+
+ See also
+ dummy_cols
+
+
+ Examples
+
+iris = as.data.table(iris)
+iris %>% dummy(Species)
+#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species_setosa
+#> <num> <num> <num> <num> <num>
+#> 1: 4.3 3.0 1.1 0.1 1
+#> 2: 4.4 2.9 1.4 0.2 1
+#> 3: 4.4 3.0 1.3 0.2 1
+#> 4: 4.4 3.2 1.3 0.2 1
+#> 5: 4.5 2.3 1.3 0.3 1
+#> ---
+#> 146: 7.7 2.6 6.9 2.3 0
+#> 147: 7.7 2.8 6.7 2.0 0
+#> 148: 7.7 3.0 6.1 2.3 0
+#> 149: 7.7 3.8 6.7 2.2 0
+#> 150: 7.9 3.8 6.4 2.0 0
+#> Species_versicolor Species_virginica
+#> <num> <num>
+#> 1: 0 0
+#> 2: 0 0
+#> 3: 0 0
+#> 4: 0 0
+#> 5: 0 0
+#> ---
+#> 146: 0 1
+#> 147: 0 1
+#> 148: 0 1
+#> 149: 0 1
+#> 150: 0 1
+iris %>% dummy(Species,longname = FALSE)
+#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width setosa versicolor
+#> <num> <num> <num> <num> <num> <num>
+#> 1: 4.3 3.0 1.1 0.1 1 0
+#> 2: 4.4 2.9 1.4 0.2 1 0
+#> 3: 4.4 3.0 1.3 0.2 1 0
+#> 4: 4.4 3.2 1.3 0.2 1 0
+#> 5: 4.5 2.3 1.3 0.3 1 0
+#> ---
+#> 146: 7.7 2.6 6.9 2.3 0 0
+#> 147: 7.7 2.8 6.7 2.0 0 0
+#> 148: 7.7 3.0 6.1 2.3 0 0
+#> 149: 7.7 3.8 6.7 2.2 0 0
+#> 150: 7.9 3.8 6.4 2.0 0 0
+#> virginica
+#> <num>
+#> 1: 0
+#> 2: 0
+#> 3: 0
+#> 4: 0
+#> 5: 0
+#> ---
+#> 146: 1
+#> 147: 1
+#> 148: 1
+#> 149: 1
+#> 150: 1
+
+mtcars = as.data.table(mtcars)
+mtcars %>% head() %>% dummy(vs,am)
+#> Key: <mpg, cyl, disp, hp, drat, wt, qsec, gear, carb, vs_0, vs_1>
+#> mpg cyl disp hp drat wt qsec gear carb vs_0 vs_1 am_0
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 18.1 6 225 105 2.76 3.460 20.22 3 1 0 1 1
+#> 2: 18.7 8 360 175 3.15 3.440 17.02 3 2 1 0 1
+#> 3: 21.0 6 160 110 3.90 2.620 16.46 4 4 1 0 0
+#> 4: 21.0 6 160 110 3.90 2.875 17.02 4 4 1 0 0
+#> 5: 21.4 6 258 110 3.08 3.215 19.44 3 1 0 1 1
+#> 6: 22.8 4 108 93 3.85 2.320 18.61 4 1 0 1 0
+#> am_1
+#> <num>
+#> 1: 0
+#> 2: 0
+#> 3: 1
+#> 4: 1
+#> 5: 0
+#> 6: 1
+mtcars %>% head() %>% dummy("cyl|gear")
+#> Key: <mpg, disp, hp, drat, wt, qsec, vs, am, carb, cyl_4, cyl_6, cyl_8>
+#> mpg disp hp drat wt qsec vs am carb cyl_4 cyl_6 cyl_8
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 18.1 225 105 2.76 3.460 20.22 1 0 1 0 1 0
+#> 2: 18.7 360 175 3.15 3.440 17.02 0 0 2 0 0 1
+#> 3: 21.0 160 110 3.90 2.620 16.46 0 1 4 0 1 0
+#> 4: 21.0 160 110 3.90 2.875 17.02 0 1 4 0 1 0
+#> 5: 21.4 258 110 3.08 3.215 19.44 1 0 1 0 1 0
+#> 6: 22.8 108 93 3.85 2.320 18.61 1 1 1 1 0 0
+#> gear_3 gear_4
+#> <num> <num>
+#> 1: 1 0
+#> 2: 1 0
+#> 3: 0 1
+#> 4: 0 1
+#> 5: 1 0
+#> 6: 0 1
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/fill.html b/docs/reference/fill.html
index 83680bc..c38eda6 100644
--- a/docs/reference/fill.html
+++ b/docs/reference/fill.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Fill in missing values with previous or next value — fill • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Fill in missing values with previous or next value — fill • tidyft
-
-
+
-
-
-
-
-
-
-
+
@@ -134,116 +59,118 @@ Fill in missing values with previous or next value
Fills missing values in selected columns using the next or previous entry.
- fill(.data, ..., direction = "down")
-
-shift_fill(x, direction = "down")
-
- Arguments
-
-
- .data
- A data.table
-
- ...
- A selection of columns.
-
- direction
- Direction in which to fill missing values.
-Currently either "down" (the default), "up".
-
- x
- A vector.
-
-
- Value
+
+ fill(.data, ..., direction = "down")
+
+shift_fill(x, direction = "down")
+
- A filled data.table
- Details
+
+ Arguments
+
+
+
+
+ Value
+ A filled data.table
+
+
+ Details
fill is filling data.table's columns,
shift_fill is filling any vectors.
+
- Examples
- #> Month Year
-#> <int> <num>
-#> 1: 1 2000
-#> 2: 2 NA
-#> 3: 3 NA
-#> 4: 4 NA
-#> 5: 5 NA
-#> 6: 6 NA
-#> 7: 7 NA
-#> 8: 8 NA
-#> 9: 9 NA
-#> 10: 10 NA
-#> 11: 11 NA
-#> 12: 12 2001df %>% fill(Year)#> Month Year
-#> <int> <num>
-#> 1: 1 2000
-#> 2: 2 2000
-#> 3: 3 2000
-#> 4: 4 2000
-#> 5: 5 2000
-#> 6: 6 2000
-#> 7: 7 2000
-#> 8: 8 2000
-#> 9: 9 2000
-#> 10: 10 2000
-#> 11: 11 2000
-#> 12: 12 2001
-df <- data.table(Month = 1:12, Year = c(2000, rep(NA, 10),2001))
-df %>% fill(Year,direction = "up")#> Month Year
-#> <int> <num>
-#> 1: 1 2000
-#> 2: 2 2001
-#> 3: 3 2001
-#> 4: 4 2001
-#> 5: 5 2001
-#> 6: 6 2001
-#> 7: 7 2001
-#> 8: 8 2001
-#> 9: 9 2001
-#> 10: 10 2001
-#> 11: 11 2001
-#> 12: 12 2001
-
-
-
+
-
+
+
-
-
-
+
diff --git a/docs/reference/filter.html b/docs/reference/filter.html
index ae0be81..e8d10dc 100644
--- a/docs/reference/filter.html
+++ b/docs/reference/filter.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Filter entries in data.frame — filter • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Filter entries in data.frame — filter • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,96 +59,100 @@ Filter entries in data.frame
Analogous function for filter in dplyr.
- filter(.data, ...)
+
+ filter(.data, ...)
+
- Arguments
-
-
- .data
- data.frame
-
- ...
- List of variables or name-value pairs of summary/modifications
-functions.
-
+
+
+ Value
+ A data.table
+
+
+ Details
Currently data.table is not able to delete rows by reference,
- References
-
- https://github.com/Rdatatable/data.table/issues/635
-https://stackoverflow.com/questions/10790204/how-to-delete-a-row-by-reference-in-data-table
- See also
-
-
-
- Examples
- #> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.1 3.0 5.9 2.1 virginica
-#> 2: 7.6 3.0 6.6 2.1 virginica
-#> 3: 7.3 2.9 6.3 1.8 virginica
-#> 4: 7.2 3.6 6.1 2.5 virginica
-#> 5: 7.7 3.8 6.7 2.2 virginica
-#> 6: 7.7 2.6 6.9 2.3 virginica
-#> 7: 7.7 2.8 6.7 2.0 virginica
-#> 8: 7.2 3.2 6.0 1.8 virginica
-#> 9: 7.2 3.0 5.8 1.6 virginica
-#> 10: 7.4 2.8 6.1 1.9 virginica
-#> 11: 7.9 3.8 6.4 2.0 virginica
-#> 12: 7.7 3.0 6.1 2.3 virginicairis %>% filter(Sepal.Length > 7,Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.2 3.6 6.1 2.5 virginica
-#> 2: 7.7 3.8 6.7 2.2 virginica
-#> 3: 7.2 3.2 6.0 1.8 virginica
-#> 4: 7.9 3.8 6.4 2.0 virginicairis %>% filter(Sepal.Length > 7 & Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.2 3.6 6.1 2.5 virginica
-#> 2: 7.7 3.8 6.7 2.2 virginica
-#> 3: 7.2 3.2 6.0 1.8 virginica
-#> 4: 7.9 3.8 6.4 2.0 virginica#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 7.9 3.8 6.4 2 virginica
-
-
+
+ References
+ https://github.com/Rdatatable/data.table/issues/635
+https://stackoverflow.com/questions/10790204/how-to-delete-a-row-by-reference-in-data-table
+
+
+ See also
+
+
+
+ Examples
+ iris = as.data.table(iris)
+iris %>% filter(Sepal.Length > 7)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.1 3.0 5.9 2.1 virginica
+#> 2: 7.6 3.0 6.6 2.1 virginica
+#> 3: 7.3 2.9 6.3 1.8 virginica
+#> 4: 7.2 3.6 6.1 2.5 virginica
+#> 5: 7.7 3.8 6.7 2.2 virginica
+#> 6: 7.7 2.6 6.9 2.3 virginica
+#> 7: 7.7 2.8 6.7 2.0 virginica
+#> 8: 7.2 3.2 6.0 1.8 virginica
+#> 9: 7.2 3.0 5.8 1.6 virginica
+#> 10: 7.4 2.8 6.1 1.9 virginica
+#> 11: 7.9 3.8 6.4 2.0 virginica
+#> 12: 7.7 3.0 6.1 2.3 virginica
+iris %>% filter(Sepal.Length > 7,Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.2 3.6 6.1 2.5 virginica
+#> 2: 7.7 3.8 6.7 2.2 virginica
+#> 3: 7.2 3.2 6.0 1.8 virginica
+#> 4: 7.9 3.8 6.4 2.0 virginica
+iris %>% filter(Sepal.Length > 7 & Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.2 3.6 6.1 2.5 virginica
+#> 2: 7.7 3.8 6.7 2.2 virginica
+#> 3: 7.2 3.2 6.0 1.8 virginica
+#> 4: 7.9 3.8 6.4 2.0 virginica
+iris %>% filter(Sepal.Length == max(Sepal.Length))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.9 3.8 6.4 2 virginica
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/fst.html b/docs/reference/fst.html
index d973203..76cc349 100644
--- a/docs/reference/fst.html
+++ b/docs/reference/fst.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-Parse,inspect and extract data.table from fst file — fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Parse,inspect and extract data.table from fst file — fst • tidyft
-
+
-
-
-
-
-
-
-
-
+
@@ -134,366 +59,403 @@ Parse,inspect and extract data.table from fst file
An API for reading fst file as data.table.
- parse_fst(path)
+
+ parse_fst(path)
+
+slice_fst(ft, row_no)
+
+select_fst(ft, ...)
+
+filter_fst(ft, ...)
+
+summary_fst(ft)
+
+
+
+ Arguments
+
-slice_fst(ft, row_no)
+- path
+path to fst file
- ft
+An object of class fst_table, returned by parse_fst
Arguments
-
-
- path
- path to fst file
-
- ft
- An object of class fst_table, returned by parse_fst
-
- row_no
- An integer vector (Positive)
-
- ...
- The filter conditions
-
+- row_no
+An integer vector (Positive)
Value
+- ...
+The filter conditions
+
+ Value
parse_fst returns a fst_table class.
select_fst and filter_fst returns a data.table.
- Details
-
+
+
+ Details
summary_fst could provide some basic information about
the fst table.
- See also
-
-
-
- Examples
-
- # write the file first
- path = tempfile(fileext = ".fst")
- fst::write_fst(iris,path)
- # parse the file but not reading it
- parse_fst(path) -> ft
-
- ft#> <fst file>
-#> 150 rows, 5 columns (filea5434c14328.fst)
-#>
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <double> <double> <double> <double> <factor>
-#> 1 5.1 3.5 1.4 0.2 setosa
-#> 2 4.9 3.0 1.4 0.2 setosa
-#> 3 4.7 3.2 1.3 0.2 setosa
-#> 4 4.6 3.1 1.5 0.2 setosa
-#> 5 5.0 3.6 1.4 0.2 setosa
-#> -- -- -- -- -- --
-#> 146 6.7 3.0 5.2 2.3 virginica
-#> 147 6.3 2.5 5.0 1.9 virginica
-#> 148 6.5 3.0 5.2 2.0 virginica
-#> 149 6.2 3.4 5.4 2.3 virginica
-#> 150 5.9 3.0 5.1 1.8 virginica
- class(ft)#> [1] "fst_table"#> $Sepal.Length
-#> [1] "numeric"
-#>
-#> $Sepal.Width
-#> [1] "numeric"
-#>
-#> $Petal.Length
-#> [1] "numeric"
-#>
-#> $Petal.Width
-#> [1] "numeric"
-#>
-#> $Species
-#> [1] "factor"
-#> names(ft)#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species" dim(ft)#> [1] 150 5 summary_fst(ft)#> <fst file>
-#> 150 rows, 5 columns (filea5434c14328.fst)
-#>
-#> * 'Sepal.Length': double
-#> * 'Sepal.Width' : double
-#> * 'Petal.Length': double
-#> * 'Petal.Width' : double
-#> * 'Species' : factor
- # get the data by query
- ft %>% slice_fst(1:3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.9 3.0 1.4 0.2 setosa
-#> 3: 4.7 3.2 1.3 0.2 setosa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.7 3.2 1.3 0.2 setosa
- ft %>% select_fst(Sepal.Length)#> Sepal.Length
-#> <num>
-#> 1: 5.1
-#> 2: 4.9
-#> 3: 4.7
-#> 4: 4.6
-#> 5: 5.0
-#> ---
-#> 146: 6.7
-#> 147: 6.3
-#> 148: 6.5
-#> 149: 6.2
-#> 150: 5.9 ft %>% select_fst(Sepal.Length,Sepal.Width)#> Sepal.Length Sepal.Width
-#> <num> <num>
-#> 1: 5.1 3.5
-#> 2: 4.9 3.0
-#> 3: 4.7 3.2
-#> 4: 4.6 3.1
-#> 5: 5.0 3.6
-#> ---
-#> 146: 6.7 3.0
-#> 147: 6.3 2.5
-#> 148: 6.5 3.0
-#> 149: 6.2 3.4
-#> 150: 5.9 3.0 ft %>% select_fst("Sepal.Length")#> Sepal.Length
-#> <num>
-#> 1: 5.1
-#> 2: 4.9
-#> 3: 4.7
-#> 4: 4.6
-#> 5: 5.0
-#> ---
-#> 146: 6.7
-#> 147: 6.3
-#> 148: 6.5
-#> 149: 6.2
-#> 150: 5.9 ft %>% select_fst(1:3)#> Sepal.Length Sepal.Width Petal.Length
-#> <num> <num> <num>
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4
-#> ---
-#> 146: 6.7 3.0 5.2
-#> 147: 6.3 2.5 5.0
-#> 148: 6.5 3.0 5.2
-#> 149: 6.2 3.4 5.4
-#> 150: 5.9 3.0 5.1 ft %>% select_fst(1,3)#> Sepal.Length Petal.Length
-#> <num> <num>
-#> 1: 5.1 1.4
-#> 2: 4.9 1.4
-#> 3: 4.7 1.3
-#> 4: 4.6 1.5
-#> 5: 5.0 1.4
-#> ---
-#> 146: 6.7 5.2
-#> 147: 6.3 5.0
-#> 148: 6.5 5.2
-#> 149: 6.2 5.4
-#> 150: 5.9 5.1 ft %>% select_fst("Se")#> Sepal.Length Sepal.Width
-#> <num> <num>
-#> 1: 5.1 3.5
-#> 2: 4.9 3.0
-#> 3: 4.7 3.2
-#> 4: 4.6 3.1
-#> 5: 5.0 3.6
-#> ---
-#> 146: 6.7 3.0
-#> 147: 6.3 2.5
-#> 148: 6.5 3.0
-#> 149: 6.2 3.4
-#> 150: 5.9 3.0
- # return a warning with message
- # \donttest{
- ft %>% select_fst("nothing")#> Warning: No matched columns,try other patterns. Names of the `fst_table` are listed.#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species" # }
-
- ft %>% select_fst("Se|Sp")#> Sepal.Length Sepal.Width Species
-#> <num> <num> <fctr>
-#> 1: 5.1 3.5 setosa
-#> 2: 4.9 3.0 setosa
-#> 3: 4.7 3.2 setosa
-#> 4: 4.6 3.1 setosa
-#> 5: 5.0 3.6 setosa
-#> ---
-#> 146: 6.7 3.0 virginica
-#> 147: 6.3 2.5 virginica
-#> 148: 6.5 3.0 virginica
-#> 149: 6.2 3.4 virginica
-#> 150: 5.9 3.0 virginica#> Sepal.Width Petal.Length
-#> <num> <num>
-#> 1: 3.5 1.4
-#> 2: 3.0 1.4
-#> 3: 3.2 1.3
-#> 4: 3.1 1.5
-#> 5: 3.6 1.4
-#> ---
-#> 146: 3.0 5.2
-#> 147: 2.5 5.0
-#> 148: 3.0 5.2
-#> 149: 3.4 5.4
-#> 150: 3.0 5.1
- ft %>% filter_fst(Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.7 3.2 1.3 0.2 setosa
-#> 3: 4.6 3.1 1.5 0.2 setosa
-#> 4: 5.0 3.6 1.4 0.2 setosa
-#> 5: 5.4 3.9 1.7 0.4 setosa
-#> 6: 4.6 3.4 1.4 0.3 setosa
-#> 7: 5.0 3.4 1.5 0.2 setosa
-#> 8: 4.9 3.1 1.5 0.1 setosa
-#> 9: 5.4 3.7 1.5 0.2 setosa
-#> 10: 4.8 3.4 1.6 0.2 setosa
-#> 11: 5.8 4.0 1.2 0.2 setosa
-#> 12: 5.7 4.4 1.5 0.4 setosa
-#> 13: 5.4 3.9 1.3 0.4 setosa
-#> 14: 5.1 3.5 1.4 0.3 setosa
-#> 15: 5.7 3.8 1.7 0.3 setosa
-#> 16: 5.1 3.8 1.5 0.3 setosa
-#> 17: 5.4 3.4 1.7 0.2 setosa
-#> 18: 5.1 3.7 1.5 0.4 setosa
-#> 19: 4.6 3.6 1.0 0.2 setosa
-#> 20: 5.1 3.3 1.7 0.5 setosa
-#> 21: 4.8 3.4 1.9 0.2 setosa
-#> 22: 5.0 3.4 1.6 0.4 setosa
-#> 23: 5.2 3.5 1.5 0.2 setosa
-#> 24: 5.2 3.4 1.4 0.2 setosa
-#> 25: 4.7 3.2 1.6 0.2 setosa
-#> 26: 4.8 3.1 1.6 0.2 setosa
-#> 27: 5.4 3.4 1.5 0.4 setosa
-#> 28: 5.2 4.1 1.5 0.1 setosa
-#> 29: 5.5 4.2 1.4 0.2 setosa
-#> 30: 4.9 3.1 1.5 0.2 setosa
-#> 31: 5.0 3.2 1.2 0.2 setosa
-#> 32: 5.5 3.5 1.3 0.2 setosa
-#> 33: 4.9 3.6 1.4 0.1 setosa
-#> 34: 5.1 3.4 1.5 0.2 setosa
-#> 35: 5.0 3.5 1.3 0.3 setosa
-#> 36: 4.4 3.2 1.3 0.2 setosa
-#> 37: 5.0 3.5 1.6 0.6 setosa
-#> 38: 5.1 3.8 1.9 0.4 setosa
-#> 39: 5.1 3.8 1.6 0.2 setosa
-#> 40: 4.6 3.2 1.4 0.2 setosa
-#> 41: 5.3 3.7 1.5 0.2 setosa
-#> 42: 5.0 3.3 1.4 0.2 setosa
-#> 43: 7.0 3.2 4.7 1.4 versicolor
-#> 44: 6.4 3.2 4.5 1.5 versicolor
-#> 45: 6.9 3.1 4.9 1.5 versicolor
-#> 46: 6.3 3.3 4.7 1.6 versicolor
-#> 47: 6.7 3.1 4.4 1.4 versicolor
-#> 48: 5.9 3.2 4.8 1.8 versicolor
-#> 49: 6.0 3.4 4.5 1.6 versicolor
-#> 50: 6.7 3.1 4.7 1.5 versicolor
-#> 51: 6.3 3.3 6.0 2.5 virginica
-#> 52: 7.2 3.6 6.1 2.5 virginica
-#> 53: 6.5 3.2 5.1 2.0 virginica
-#> 54: 6.4 3.2 5.3 2.3 virginica
-#> 55: 7.7 3.8 6.7 2.2 virginica
-#> 56: 6.9 3.2 5.7 2.3 virginica
-#> 57: 6.7 3.3 5.7 2.1 virginica
-#> 58: 7.2 3.2 6.0 1.8 virginica
-#> 59: 7.9 3.8 6.4 2.0 virginica
-#> 60: 6.3 3.4 5.6 2.4 virginica
-#> 61: 6.4 3.1 5.5 1.8 virginica
-#> 62: 6.9 3.1 5.4 2.1 virginica
-#> 63: 6.7 3.1 5.6 2.4 virginica
-#> 64: 6.9 3.1 5.1 2.3 virginica
-#> 65: 6.8 3.2 5.9 2.3 virginica
-#> 66: 6.7 3.3 5.7 2.5 virginica
-#> 67: 6.2 3.4 5.4 2.3 virginica
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species ft %>% filter_fst(Sepal.Length > 6 , Species == "virginica")#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 6.3 3.3 6.0 2.5 virginica
-#> 2: 7.1 3.0 5.9 2.1 virginica
-#> 3: 6.3 2.9 5.6 1.8 virginica
-#> 4: 6.5 3.0 5.8 2.2 virginica
-#> 5: 7.6 3.0 6.6 2.1 virginica
-#> 6: 7.3 2.9 6.3 1.8 virginica
-#> 7: 6.7 2.5 5.8 1.8 virginica
-#> 8: 7.2 3.6 6.1 2.5 virginica
-#> 9: 6.5 3.2 5.1 2.0 virginica
-#> 10: 6.4 2.7 5.3 1.9 virginica
-#> 11: 6.8 3.0 5.5 2.1 virginica
-#> 12: 6.4 3.2 5.3 2.3 virginica
-#> 13: 6.5 3.0 5.5 1.8 virginica
-#> 14: 7.7 3.8 6.7 2.2 virginica
-#> 15: 7.7 2.6 6.9 2.3 virginica
-#> 16: 6.9 3.2 5.7 2.3 virginica
-#> 17: 7.7 2.8 6.7 2.0 virginica
-#> 18: 6.3 2.7 4.9 1.8 virginica
-#> 19: 6.7 3.3 5.7 2.1 virginica
-#> 20: 7.2 3.2 6.0 1.8 virginica
-#> 21: 6.2 2.8 4.8 1.8 virginica
-#> 22: 6.1 3.0 4.9 1.8 virginica
-#> 23: 6.4 2.8 5.6 2.1 virginica
-#> 24: 7.2 3.0 5.8 1.6 virginica
-#> 25: 7.4 2.8 6.1 1.9 virginica
-#> 26: 7.9 3.8 6.4 2.0 virginica
-#> 27: 6.4 2.8 5.6 2.2 virginica
-#> 28: 6.3 2.8 5.1 1.5 virginica
-#> 29: 6.1 2.6 5.6 1.4 virginica
-#> 30: 7.7 3.0 6.1 2.3 virginica
-#> 31: 6.3 3.4 5.6 2.4 virginica
-#> 32: 6.4 3.1 5.5 1.8 virginica
-#> 33: 6.9 3.1 5.4 2.1 virginica
-#> 34: 6.7 3.1 5.6 2.4 virginica
-#> 35: 6.9 3.1 5.1 2.3 virginica
-#> 36: 6.8 3.2 5.9 2.3 virginica
-#> 37: 6.7 3.3 5.7 2.5 virginica
-#> 38: 6.7 3.0 5.2 2.3 virginica
-#> 39: 6.3 2.5 5.0 1.9 virginica
-#> 40: 6.5 3.0 5.2 2.0 virginica
-#> 41: 6.2 3.4 5.4 2.3 virginica
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species ft %>% filter_fst(Sepal.Length > 6 & Species == "virginica" & Sepal.Width < 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 6.3 2.9 5.6 1.8 virginica
-#> 2: 7.3 2.9 6.3 1.8 virginica
-#> 3: 6.7 2.5 5.8 1.8 virginica
-#> 4: 6.4 2.7 5.3 1.9 virginica
-#> 5: 7.7 2.6 6.9 2.3 virginica
-#> 6: 7.7 2.8 6.7 2.0 virginica
-#> 7: 6.3 2.7 4.9 1.8 virginica
-#> 8: 6.2 2.8 4.8 1.8 virginica
-#> 9: 6.4 2.8 5.6 2.1 virginica
-#> 10: 7.4 2.8 6.1 1.9 virginica
-#> 11: 6.4 2.8 5.6 2.2 virginica
-#> 12: 6.3 2.8 5.1 1.5 virginica
-#> 13: 6.1 2.6 5.6 1.4 virginica
-#> 14: 6.3 2.5 5.0 1.9 virginica
-
-
-
+
+ See also
+
+
+
+ Examples
+
+ # write the file first
+ path = tempfile(fileext = ".fst")
+ fst::write_fst(iris,path)
+ # parse the file but not reading it
+ parse_fst(path) -> ft
+
+ ft
+#> <fst file>
+#> 150 rows, 5 columns (file27604466d41.fst)
+#>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <double> <double> <double> <double> <factor>
+#> 1 5.1 3.5 1.4 0.2 setosa
+#> 2 4.9 3.0 1.4 0.2 setosa
+#> 3 4.7 3.2 1.3 0.2 setosa
+#> 4 4.6 3.1 1.5 0.2 setosa
+#> 5 5.0 3.6 1.4 0.2 setosa
+#> -- -- -- -- -- --
+#> 146 6.7 3.0 5.2 2.3 virginica
+#> 147 6.3 2.5 5.0 1.9 virginica
+#> 148 6.5 3.0 5.2 2.0 virginica
+#> 149 6.2 3.4 5.4 2.3 virginica
+#> 150 5.9 3.0 5.1 1.8 virginica
+
+ class(ft)
+#> [1] "fst_table"
+ lapply(ft,class)
+#> $Sepal.Length
+#> [1] "numeric"
+#>
+#> $Sepal.Width
+#> [1] "numeric"
+#>
+#> $Petal.Length
+#> [1] "numeric"
+#>
+#> $Petal.Width
+#> [1] "numeric"
+#>
+#> $Species
+#> [1] "factor"
+#>
+ names(ft)
+#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species"
+ dim(ft)
+#> [1] 150 5
+ summary_fst(ft)
+#> <fst file>
+#> 150 rows, 5 columns (file27604466d41.fst)
+#>
+#> * 'Sepal.Length': double
+#> * 'Sepal.Width' : double
+#> * 'Petal.Length': double
+#> * 'Petal.Width' : double
+#> * 'Species' : factor
+
+ # get the data by query
+ ft %>% slice_fst(1:3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.9 3.0 1.4 0.2 setosa
+#> 3: 4.7 3.2 1.3 0.2 setosa
+ ft %>% slice_fst(c(1,3))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.7 3.2 1.3 0.2 setosa
+
+ ft %>% select_fst(Sepal.Length)
+#> Sepal.Length
+#> <num>
+#> 1: 5.1
+#> 2: 4.9
+#> 3: 4.7
+#> 4: 4.6
+#> 5: 5.0
+#> ---
+#> 146: 6.7
+#> 147: 6.3
+#> 148: 6.5
+#> 149: 6.2
+#> 150: 5.9
+ ft %>% select_fst(Sepal.Length,Sepal.Width)
+#> Sepal.Length Sepal.Width
+#> <num> <num>
+#> 1: 5.1 3.5
+#> 2: 4.9 3.0
+#> 3: 4.7 3.2
+#> 4: 4.6 3.1
+#> 5: 5.0 3.6
+#> ---
+#> 146: 6.7 3.0
+#> 147: 6.3 2.5
+#> 148: 6.5 3.0
+#> 149: 6.2 3.4
+#> 150: 5.9 3.0
+ ft %>% select_fst("Sepal.Length")
+#> Sepal.Length
+#> <num>
+#> 1: 5.1
+#> 2: 4.9
+#> 3: 4.7
+#> 4: 4.6
+#> 5: 5.0
+#> ---
+#> 146: 6.7
+#> 147: 6.3
+#> 148: 6.5
+#> 149: 6.2
+#> 150: 5.9
+ ft %>% select_fst(1:3)
+#> Sepal.Length Sepal.Width Petal.Length
+#> <num> <num> <num>
+#> 1: 5.1 3.5 1.4
+#> 2: 4.9 3.0 1.4
+#> 3: 4.7 3.2 1.3
+#> 4: 4.6 3.1 1.5
+#> 5: 5.0 3.6 1.4
+#> ---
+#> 146: 6.7 3.0 5.2
+#> 147: 6.3 2.5 5.0
+#> 148: 6.5 3.0 5.2
+#> 149: 6.2 3.4 5.4
+#> 150: 5.9 3.0 5.1
+ ft %>% select_fst(1,3)
+#> Sepal.Length Petal.Length
+#> <num> <num>
+#> 1: 5.1 1.4
+#> 2: 4.9 1.4
+#> 3: 4.7 1.3
+#> 4: 4.6 1.5
+#> 5: 5.0 1.4
+#> ---
+#> 146: 6.7 5.2
+#> 147: 6.3 5.0
+#> 148: 6.5 5.2
+#> 149: 6.2 5.4
+#> 150: 5.9 5.1
+ ft %>% select_fst("Se")
+#> Sepal.Length Sepal.Width
+#> <num> <num>
+#> 1: 5.1 3.5
+#> 2: 4.9 3.0
+#> 3: 4.7 3.2
+#> 4: 4.6 3.1
+#> 5: 5.0 3.6
+#> ---
+#> 146: 6.7 3.0
+#> 147: 6.3 2.5
+#> 148: 6.5 3.0
+#> 149: 6.2 3.4
+#> 150: 5.9 3.0
+
+ # return a warning with message
+ # \donttest{
+ ft %>% select_fst("nothing")
+#> Warning: No matched columns,try other patterns. Names of the `fst_table` are listed.
+#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species"
+ # }
+
+ ft %>% select_fst("Se|Sp")
+#> Sepal.Length Sepal.Width Species
+#> <num> <num> <fctr>
+#> 1: 5.1 3.5 setosa
+#> 2: 4.9 3.0 setosa
+#> 3: 4.7 3.2 setosa
+#> 4: 4.6 3.1 setosa
+#> 5: 5.0 3.6 setosa
+#> ---
+#> 146: 6.7 3.0 virginica
+#> 147: 6.3 2.5 virginica
+#> 148: 6.5 3.0 virginica
+#> 149: 6.2 3.4 virginica
+#> 150: 5.9 3.0 virginica
+ ft %>% select_fst(cols = names(iris)[2:3])
+#> Sepal.Width Petal.Length
+#> <num> <num>
+#> 1: 3.5 1.4
+#> 2: 3.0 1.4
+#> 3: 3.2 1.3
+#> 4: 3.1 1.5
+#> 5: 3.6 1.4
+#> ---
+#> 146: 3.0 5.2
+#> 147: 2.5 5.0
+#> 148: 3.0 5.2
+#> 149: 3.4 5.4
+#> 150: 3.0 5.1
+
+ ft %>% filter_fst(Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.7 3.2 1.3 0.2 setosa
+#> 3: 4.6 3.1 1.5 0.2 setosa
+#> 4: 5.0 3.6 1.4 0.2 setosa
+#> 5: 5.4 3.9 1.7 0.4 setosa
+#> 6: 4.6 3.4 1.4 0.3 setosa
+#> 7: 5.0 3.4 1.5 0.2 setosa
+#> 8: 4.9 3.1 1.5 0.1 setosa
+#> 9: 5.4 3.7 1.5 0.2 setosa
+#> 10: 4.8 3.4 1.6 0.2 setosa
+#> 11: 5.8 4.0 1.2 0.2 setosa
+#> 12: 5.7 4.4 1.5 0.4 setosa
+#> 13: 5.4 3.9 1.3 0.4 setosa
+#> 14: 5.1 3.5 1.4 0.3 setosa
+#> 15: 5.7 3.8 1.7 0.3 setosa
+#> 16: 5.1 3.8 1.5 0.3 setosa
+#> 17: 5.4 3.4 1.7 0.2 setosa
+#> 18: 5.1 3.7 1.5 0.4 setosa
+#> 19: 4.6 3.6 1.0 0.2 setosa
+#> 20: 5.1 3.3 1.7 0.5 setosa
+#> 21: 4.8 3.4 1.9 0.2 setosa
+#> 22: 5.0 3.4 1.6 0.4 setosa
+#> 23: 5.2 3.5 1.5 0.2 setosa
+#> 24: 5.2 3.4 1.4 0.2 setosa
+#> 25: 4.7 3.2 1.6 0.2 setosa
+#> 26: 4.8 3.1 1.6 0.2 setosa
+#> 27: 5.4 3.4 1.5 0.4 setosa
+#> 28: 5.2 4.1 1.5 0.1 setosa
+#> 29: 5.5 4.2 1.4 0.2 setosa
+#> 30: 4.9 3.1 1.5 0.2 setosa
+#> 31: 5.0 3.2 1.2 0.2 setosa
+#> 32: 5.5 3.5 1.3 0.2 setosa
+#> 33: 4.9 3.6 1.4 0.1 setosa
+#> 34: 5.1 3.4 1.5 0.2 setosa
+#> 35: 5.0 3.5 1.3 0.3 setosa
+#> 36: 4.4 3.2 1.3 0.2 setosa
+#> 37: 5.0 3.5 1.6 0.6 setosa
+#> 38: 5.1 3.8 1.9 0.4 setosa
+#> 39: 5.1 3.8 1.6 0.2 setosa
+#> 40: 4.6 3.2 1.4 0.2 setosa
+#> 41: 5.3 3.7 1.5 0.2 setosa
+#> 42: 5.0 3.3 1.4 0.2 setosa
+#> 43: 7.0 3.2 4.7 1.4 versicolor
+#> 44: 6.4 3.2 4.5 1.5 versicolor
+#> 45: 6.9 3.1 4.9 1.5 versicolor
+#> 46: 6.3 3.3 4.7 1.6 versicolor
+#> 47: 6.7 3.1 4.4 1.4 versicolor
+#> 48: 5.9 3.2 4.8 1.8 versicolor
+#> 49: 6.0 3.4 4.5 1.6 versicolor
+#> 50: 6.7 3.1 4.7 1.5 versicolor
+#> 51: 6.3 3.3 6.0 2.5 virginica
+#> 52: 7.2 3.6 6.1 2.5 virginica
+#> 53: 6.5 3.2 5.1 2.0 virginica
+#> 54: 6.4 3.2 5.3 2.3 virginica
+#> 55: 7.7 3.8 6.7 2.2 virginica
+#> 56: 6.9 3.2 5.7 2.3 virginica
+#> 57: 6.7 3.3 5.7 2.1 virginica
+#> 58: 7.2 3.2 6.0 1.8 virginica
+#> 59: 7.9 3.8 6.4 2.0 virginica
+#> 60: 6.3 3.4 5.6 2.4 virginica
+#> 61: 6.4 3.1 5.5 1.8 virginica
+#> 62: 6.9 3.1 5.4 2.1 virginica
+#> 63: 6.7 3.1 5.6 2.4 virginica
+#> 64: 6.9 3.1 5.1 2.3 virginica
+#> 65: 6.8 3.2 5.9 2.3 virginica
+#> 66: 6.7 3.3 5.7 2.5 virginica
+#> 67: 6.2 3.4 5.4 2.3 virginica
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+ ft %>% filter_fst(Sepal.Length > 6 , Species == "virginica")
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 6.3 3.3 6.0 2.5 virginica
+#> 2: 7.1 3.0 5.9 2.1 virginica
+#> 3: 6.3 2.9 5.6 1.8 virginica
+#> 4: 6.5 3.0 5.8 2.2 virginica
+#> 5: 7.6 3.0 6.6 2.1 virginica
+#> 6: 7.3 2.9 6.3 1.8 virginica
+#> 7: 6.7 2.5 5.8 1.8 virginica
+#> 8: 7.2 3.6 6.1 2.5 virginica
+#> 9: 6.5 3.2 5.1 2.0 virginica
+#> 10: 6.4 2.7 5.3 1.9 virginica
+#> 11: 6.8 3.0 5.5 2.1 virginica
+#> 12: 6.4 3.2 5.3 2.3 virginica
+#> 13: 6.5 3.0 5.5 1.8 virginica
+#> 14: 7.7 3.8 6.7 2.2 virginica
+#> 15: 7.7 2.6 6.9 2.3 virginica
+#> 16: 6.9 3.2 5.7 2.3 virginica
+#> 17: 7.7 2.8 6.7 2.0 virginica
+#> 18: 6.3 2.7 4.9 1.8 virginica
+#> 19: 6.7 3.3 5.7 2.1 virginica
+#> 20: 7.2 3.2 6.0 1.8 virginica
+#> 21: 6.2 2.8 4.8 1.8 virginica
+#> 22: 6.1 3.0 4.9 1.8 virginica
+#> 23: 6.4 2.8 5.6 2.1 virginica
+#> 24: 7.2 3.0 5.8 1.6 virginica
+#> 25: 7.4 2.8 6.1 1.9 virginica
+#> 26: 7.9 3.8 6.4 2.0 virginica
+#> 27: 6.4 2.8 5.6 2.2 virginica
+#> 28: 6.3 2.8 5.1 1.5 virginica
+#> 29: 6.1 2.6 5.6 1.4 virginica
+#> 30: 7.7 3.0 6.1 2.3 virginica
+#> 31: 6.3 3.4 5.6 2.4 virginica
+#> 32: 6.4 3.1 5.5 1.8 virginica
+#> 33: 6.9 3.1 5.4 2.1 virginica
+#> 34: 6.7 3.1 5.6 2.4 virginica
+#> 35: 6.9 3.1 5.1 2.3 virginica
+#> 36: 6.8 3.2 5.9 2.3 virginica
+#> 37: 6.7 3.3 5.7 2.5 virginica
+#> 38: 6.7 3.0 5.2 2.3 virginica
+#> 39: 6.3 2.5 5.0 1.9 virginica
+#> 40: 6.5 3.0 5.2 2.0 virginica
+#> 41: 6.2 3.4 5.4 2.3 virginica
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+ ft %>% filter_fst(Sepal.Length > 6 & Species == "virginica" & Sepal.Width < 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 6.3 2.9 5.6 1.8 virginica
+#> 2: 7.3 2.9 6.3 1.8 virginica
+#> 3: 6.7 2.5 5.8 1.8 virginica
+#> 4: 6.4 2.7 5.3 1.9 virginica
+#> 5: 7.7 2.6 6.9 2.3 virginica
+#> 6: 7.7 2.8 6.7 2.0 virginica
+#> 7: 6.3 2.7 4.9 1.8 virginica
+#> 8: 6.2 2.8 4.8 1.8 virginica
+#> 9: 6.4 2.8 5.6 2.1 virginica
+#> 10: 7.4 2.8 6.1 1.9 virginica
+#> 11: 6.4 2.8 5.6 2.2 virginica
+#> 12: 6.3 2.8 5.1 1.5 virginica
+#> 13: 6.1 2.6 5.6 1.4 virginica
+#> 14: 6.3 2.5 5.0 1.9 virginica
+
+
+
+
-
+
+
-
-
-
+
diff --git a/docs/reference/fst_io.html b/docs/reference/fst_io.html
index 68160fc..0b22969 100644
--- a/docs/reference/fst_io.html
+++ b/docs/reference/fst_io.html
@@ -1,74 +1,14 @@
-
-
-
-
-
-
-
-Read and write fst files — export_fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Read and write fst files — export_fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
+
- Wrapper for read_fst and write_fst
+
Wrapper for read_fst and write_fst
from fst, but use a different default. For data import, always return a data.table.
For data export, always compress the data to the smallest size.
- export_fst(x, path, compress = 100, uniform_encoding = TRUE)
-
-import_fst(
- path,
- columns = NULL,
- from = 1,
- to = NULL,
- as.data.table = TRUE,
- old_format = FALSE
-)
-
- Arguments
- data.table package to be installed.
+
- Value
+old_format
+must be FALSE, the old fst file format is deprecated and can only be read and
+converted with fst package versions 0.8.0 to 0.8.10.
Value
`import_fst` returns a data.table with the selected columns and rows. `export_fst`
writes `x` to a `fst` file and invisibly returns `x` (so you can use this function in a pipeline).
- See also
-
-
-
- Examples
-
-# \donttest{
-export_fst(iris,"iris_fst_test.fst")
-iris_dt = import_fst("iris_fst_test.fst")
-iris_dt#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> <num> <num> <num> <num> <fctr>
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.9 3.0 1.4 0.2 setosa
-#> 3: 4.7 3.2 1.3 0.2 setosa
-#> 4: 4.6 3.1 1.5 0.2 setosa
-#> 5: 5.0 3.6 1.4 0.2 setosa
-#> ---
-#> 146: 6.7 3.0 5.2 2.3 virginica
-#> 147: 6.3 2.5 5.0 1.9 virginica
-#> 148: 6.5 3.0 5.2 2.0 virginica
-#> 149: 6.2 3.4 5.4 2.3 virginica
-#> 150: 5.9 3.0 5.1 1.8 virginica
-
-
+
+ See also
+
+
+
+ Examples
+
+# \donttest{
+export_fst(iris,"iris_fst_test.fst")
+iris_dt = import_fst("iris_fst_test.fst")
+iris_dt
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.9 3.0 1.4 0.2 setosa
+#> 3: 4.7 3.2 1.3 0.2 setosa
+#> 4: 4.6 3.1 1.5 0.2 setosa
+#> 5: 5.0 3.6 1.4 0.2 setosa
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica
+#> 147: 6.3 2.5 5.0 1.9 virginica
+#> 148: 6.5 3.0 5.2 2.0 virginica
+#> 149: 6.2 3.4 5.4 2.3 virginica
+#> 150: 5.9 3.0 5.1 1.8 virginica
+unlink("iris_fst_test.fst")
+# }
+
+
+
+
-
+
+
-
-
-
+
- Save a data.frame as a fst table — as_fst • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Save a data.frame as a fst table — as_fst • tidyft
-
+
-
-
-
Complete a data frame with missing combinations of data — complete • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Complete a data frame with missing combinations of data — complete • tidyft
-
+
-
-
-
Count observations by group — count • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Count observations by group — count • tidyft
-
+
-
-
-
Cumulative mean — cummean • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Cumulative mean — cummean • tidyft
-
+
-
-
-
Select distinct/unique rows in data.table — distinct • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Select distinct/unique rows in data.table — distinct • tidyft
-
+
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/drop_delete_na.html b/docs/reference/drop_delete_na.html
index 3699b00..a05fd54 100644
--- a/docs/reference/drop_delete_na.html
+++ b/docs/reference/drop_delete_na.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-
-
-
- Arrange entries in data.frame — arrange • tidyft
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Arrange entries in data.frame — arrange • tidyft
-
-
+
-
-
+
+
-
-
-
+
diff --git a/docs/reference/as_fst.html b/docs/reference/as_fst.html
index 300e5ec..c5acdd9 100644
--- a/docs/reference/as_fst.html
+++ b/docs/reference/as_fst.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/pkgdown.css b/docs/pkgdown.css
index 9145958..80ea5b8 100644
--- a/docs/pkgdown.css
+++ b/docs/pkgdown.css
@@ -17,6 +17,10 @@ html, body {
height: 100%;
}
+body {
+ position: relative;
+}
+
body > .container {
display: flex;
height: 100%;
@@ -52,8 +56,10 @@ img.icon {
float: right;
}
-img {
+/* Ensure in-page images don't run outside their container */
+.contents img {
max-width: 100%;
+ height: auto;
}
/* Fix bug in bootstrap (only seen in firefox) */
@@ -67,14 +73,17 @@ summary {
margin-top: calc(-60px + 1em);
}
+dd {
+ margin-left: 3em;
+}
+
/* Section anchors ---------------------------------*/
a.anchor {
- margin-left: -30px;
- display:inline-block;
- width: 30px;
- height: 30px;
- visibility: hidden;
+ display: none;
+ margin-left: 5px;
+ width: 20px;
+ height: 20px;
background-image: url(./link.svg);
background-repeat: no-repeat;
@@ -82,17 +91,15 @@ a.anchor {
background-position: center center;
}
-.hasAnchor:hover a.anchor {
- visibility: visible;
+h1:hover .anchor,
+h2:hover .anchor,
+h3:hover .anchor,
+h4:hover .anchor,
+h5:hover .anchor,
+h6:hover .anchor {
+ display: inline-block;
}
-@media (max-width: 767px) {
- .hasAnchor:hover a.anchor {
- visibility: hidden;
- }
-}
-
-
/* Fixes for fixed navbar --------------------------*/
.contents h1, .contents h2, .contents h3, .contents h4 {
@@ -100,29 +107,132 @@ a.anchor {
margin-top: -40px;
}
+/* Navbar submenu --------------------------*/
+
+.dropdown-submenu {
+ position: relative;
+}
+
+.dropdown-submenu>.dropdown-menu {
+ top: 0;
+ left: 100%;
+ margin-top: -6px;
+ margin-left: -1px;
+ border-radius: 0 6px 6px 6px;
+}
+
+.dropdown-submenu:hover>.dropdown-menu {
+ display: block;
+}
+
+.dropdown-submenu>a:after {
+ display: block;
+ content: " ";
+ float: right;
+ width: 0;
+ height: 0;
+ border-color: transparent;
+ border-style: solid;
+ border-width: 5px 0 5px 5px;
+ border-left-color: #cccccc;
+ margin-top: 5px;
+ margin-right: -10px;
+}
+
+.dropdown-submenu:hover>a:after {
+ border-left-color: #ffffff;
+}
+
+.dropdown-submenu.pull-left {
+ float: none;
+}
+
+.dropdown-submenu.pull-left>.dropdown-menu {
+ left: -100%;
+ margin-left: 10px;
+ border-radius: 6px 0 6px 6px;
+}
+
/* Sidebar --------------------------*/
-#sidebar {
+#pkgdown-sidebar {
margin-top: 30px;
position: -webkit-sticky;
position: sticky;
top: 70px;
}
-#sidebar h2 {
+
+#pkgdown-sidebar h2 {
font-size: 1.5em;
margin-top: 1em;
}
-#sidebar h2:first-child {
+#pkgdown-sidebar h2:first-child {
margin-top: 0;
}
-#sidebar .list-unstyled li {
+#pkgdown-sidebar .list-unstyled li {
margin-bottom: 0.5em;
}
+/* bootstrap-toc tweaks ------------------------------------------------------*/
+
+/* All levels of nav */
+
+nav[data-toggle='toc'] .nav > li > a {
+ padding: 4px 20px 4px 6px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+}
+
+nav[data-toggle='toc'] .nav > li > a:hover,
+nav[data-toggle='toc'] .nav > li > a:focus {
+ padding-left: 5px;
+ color: inherit;
+ border-left: 1px solid #878787;
+}
+
+nav[data-toggle='toc'] .nav > .active > a,
+nav[data-toggle='toc'] .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav > .active:focus > a {
+ padding-left: 5px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+ border-left: 2px solid #878787;
+}
+
+/* Nav: second level (shown on .active) */
+
+nav[data-toggle='toc'] .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a {
+ padding-left: 16px;
+ font-size: 1.35rem;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a:hover,
+nav[data-toggle='toc'] .nav .nav > li > a:focus {
+ padding-left: 15px;
+}
+
+nav[data-toggle='toc'] .nav .nav > .active > a,
+nav[data-toggle='toc'] .nav .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav .nav > .active:focus > a {
+ padding-left: 15px;
+ font-weight: 500;
+ font-size: 1.35rem;
+}
+
+/* orcid ------------------------------------------------------------------- */
+
.orcid {
- height: 16px;
+ font-size: 16px;
+ color: #A6CE39;
/* margins are required by official ORCID trademark and display guidelines */
margin-left:4px;
margin-right:4px;
@@ -133,14 +243,14 @@ a.anchor {
.ref-index th {font-weight: normal;}
-.ref-index td {vertical-align: top;}
+.ref-index td {vertical-align: top; min-width: 100px}
.ref-index .icon {width: 40px;}
.ref-index .alias {width: 40%;}
.ref-index-icons .alias {width: calc(40% - 40px);}
.ref-index .title {width: 60%;}
.ref-arguments th {text-align: right; padding-right: 10px;}
-.ref-arguments th, .ref-arguments td {vertical-align: top;}
+.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
.ref-arguments .name {width: 20%;}
.ref-arguments .desc {width: 80%;}
@@ -153,31 +263,26 @@ table {
/* Syntax highlighting ---------------------------------------------------- */
-pre {
- word-wrap: normal;
- word-break: normal;
- border: 1px solid #eee;
-}
-
-pre, code {
+pre, code, pre code {
background-color: #f8f8f8;
color: #333;
}
+pre, pre code {
+ white-space: pre-wrap;
+ word-break: break-all;
+ overflow-wrap: break-word;
+}
-pre code {
- overflow: auto;
- word-wrap: normal;
- white-space: pre;
+pre {
+ border: 1px solid #eee;
}
-pre .img {
+pre .img, pre .r-plt {
margin: 5px 0;
}
-pre .img img {
+pre .img img, pre .r-plt img {
background-color: #fff;
- display: block;
- height: auto;
}
code a, pre a {
@@ -194,9 +299,8 @@ a.sourceLine:hover {
.kw {color: #264D66;} /* keyword */
.co {color: #888888;} /* comment */
-.message { color: black; font-weight: bolder;}
-.error { color: orange; font-weight: bolder;}
-.warning { color: #6A0366; font-weight: bolder;}
+.error {font-weight: bolder;}
+.warning {font-weight: bolder;}
/* Clipboard --------------------------*/
@@ -254,3 +358,27 @@ mark {
content: "";
}
}
+
+/* Section anchors ---------------------------------
+ Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
+*/
+
+div.csl-bib-body { }
+div.csl-entry {
+ clear: both;
+}
+.hanging-indent div.csl-entry {
+ margin-left:2em;
+ text-indent:-2em;
+}
+div.csl-left-margin {
+ min-width:2em;
+ float:left;
+}
+div.csl-right-inline {
+ margin-left:2em;
+ padding-left:1em;
+}
+div.csl-indent {
+ margin-left: 2em;
+}
diff --git a/docs/pkgdown.js b/docs/pkgdown.js
index 087a762..6f0eee4 100644
--- a/docs/pkgdown.js
+++ b/docs/pkgdown.js
@@ -9,11 +9,6 @@
$('body').css('padding-top', $('.navbar').height() + 10);
});
- $('body').scrollspy({
- target: '#sidebar',
- offset: 60
- });
-
$('[data-toggle="tooltip"]').tooltip();
var cur_path = paths(location.pathname);
@@ -85,7 +80,7 @@
$(document).ready(function() {
var copyButton = "";
- $(".examples, div.sourceCode").addClass("hasCopyButton");
+ $("div.sourceCode").addClass("hasCopyButton");
// Insert copy buttons:
$(copyButton).prependTo(".hasCopyButton");
@@ -96,7 +91,7 @@
// Initialize clipboard:
var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', {
text: function(trigger) {
- return trigger.parentNode.textContent;
+ return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, "");
}
});
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index e93a3fb..eb9bb62 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -1,6 +1,6 @@
-pandoc: 2.7.2
-pkgdown: 1.4.1
+pandoc: 3.1.11
+pkgdown: 2.1.0
pkgdown_sha: ~
articles:
Introduction: Introduction.html
-
+last_built: 2024-09-22T01:35Z
diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png
new file mode 100644
index 0000000000000000000000000000000000000000..17a358060aed2a86950757bbd25c6f92c08c458f
GIT binary patch
literal 1011
zcmeAS@N?(olHy`uVBq!ia0y~yV0-|=9Be?5+AI5}0x7m6Z+90U4Fo@(ch>_c&H|6f
zVg?3oArNM~bhqvg0|WD9PZ!6KiaBo&GBN^{G%5UFpXcEKVvd5*5Eu=C0SJK)8A6*F
U7`aXvEC5;V>FVdQ&MBb@00SN#Z2$lO
literal 0
HcmV?d00001
diff --git a/docs/reference/arrange.html b/docs/reference/arrange.html
index 004dadc..ec794b1 100644
--- a/docs/reference/arrange.html
+++ b/docs/reference/arrange.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
+
-
+
+
+
-
-
-
-
+
-
-
-
-
-
- 
-
-
-
--Overview
-tidyft is an extension of data.table. Using modification by reference whenever possible, this toolkit is designed for big data analysis in high-performance desktop or laptop computers. The syntax of the package is similar or identical to tidyverse. It is user friendly, memory efficient and time saving. For more information, check its ancestor package tidyfst.
-This design is best for big data manipulation on out of memory data using facilities provided by fst. In such ways, you can handle the most quantity of data in the least time and space on your computer.
-
-
-
--Example
-This is a basic example which shows you how to solve a common problem:
-library(tidyft)
-
-# get first 5 rows of iris
-as.data.table(iris)[1:5] -> a
-#show
-a
-#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
-#> 1: 5.1 3.5 1.4 0.2 setosa
-#> 2: 4.9 3.0 1.4 0.2 setosa
-#> 3: 4.7 3.2 1.3 0.2 setosa
-#> 4: 4.6 3.1 1.5 0.2 setosa
-#> 5: 5.0 3.6 1.4 0.2 setosa
-
-# if you select
-a %>% select(1:3)
-#> Sepal.Length Sepal.Width Petal.Length
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4
-
-# you lose the unselected columns forever
-a
-#> Sepal.Length Sepal.Width Petal.Length
-#> 1: 5.1 3.5 1.4
-#> 2: 4.9 3.0 1.4
-#> 3: 4.7 3.2 1.3
-#> 4: 4.6 3.1 1.5
-#> 5: 5.0 3.6 1.4If you still want to keep the original data, use copy() to make a copy beforehand.
-
--Tutorial
-See vignettes.
-
-
--Performance
-
-
-rm(list = ls())
-
-library(profvis)
-library(dplyr)
-library(tidyft)
-as.data.frame(starwars) -> starwars
-starwars[sample.int(1:nrow(starwars),1e6,replace = T),] -> starwars
-copy(starwars) -> dat1
-copy(starwars) -> dat2
-copy(starwars) -> dat3
-
-profvis({
- dat1 %>%
- dplyr::as_tibble() %>%
- dplyr::select(name, dplyr::ends_with("color")) %>%
- dplyr::arrange(hair_color,skin_color,eye_color) -> a
-
- setorder(setDT(dat2)[,.SD,.SDcols = patterns("name|color$")],
- hair_color,skin_color,eye_color) -> b
-
- dat3 %>%
- tidyft::setDT() %>%
- tidyft::select("name|color$") %>%
- tidyft::arrange(hair_color,skin_color,eye_color) -> c
-
-
-})
-
-all.equal(a,b)
-#> [1] TRUE
-all.equal(b,c)
-#> [1] TRUE
-
-
-
-
-
-
-
+
-
+If present, override order
+
+
@@ -134,128 +59,132 @@
- Arrange entries in data.frame
Analogous function for arrange in dplyr.
arrange(.data, ..., cols = NULL, order = 1L)- -
Arguments
-| .data | -data.frame |
-
|---|---|
| ... | -Arrange by what group? Minus symbol means arrange by -descending order. |
-
| cols | -For
+
+
+ |
-
| order | -For |
-
.... Defaults to NULL.
- Value
-A data.table
-Details
+For set_arrange only. An integer vector with only possible
+values of 1 and -1, corresponding to ascending and descending order.
+Defaults to 1.
+
+ Value
+A data.table
+
+
-
+
+ Details
Once arranged, the order of entries would be changed forever.
-See also
- - - -Examples
--#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 4.3 3.0 1.1 0.1 setosa -#> 2: 4.4 2.9 1.4 0.2 setosa -#> 3: 4.4 3.0 1.3 0.2 setosa -#> 4: 4.4 3.2 1.3 0.2 setosa -#> 5: 4.5 2.3 1.3 0.3 setosa -#> --- -#> 146: 7.7 3.8 6.7 2.2 virginica -#> 147: 7.7 2.6 6.9 2.3 virginica -#> 148: 7.7 2.8 6.7 2.0 virginica -#> 149: 7.7 3.0 6.1 2.3 virginica -#> 150: 7.9 3.8 6.4 2.0 virginicaa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 4.3 3.0 1.1 0.1 setosa -#> 2: 4.4 2.9 1.4 0.2 setosa -#> 3: 4.4 3.0 1.3 0.2 setosa -#> 4: 4.4 3.2 1.3 0.2 setosa -#> 5: 4.5 2.3 1.3 0.3 setosa -#> --- -#> 146: 7.7 3.8 6.7 2.2 virginica -#> 147: 7.7 2.6 6.9 2.3 virginica -#> 148: 7.7 2.8 6.7 2.0 virginica -#> 149: 7.7 3.0 6.1 2.3 virginica -#> 150: 7.9 3.8 6.4 2.0 virginica#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 5.0 2.0 3.5 1.0 versicolor -#> 2: 6.0 2.2 4.0 1.0 versicolor -#> 3: 6.2 2.2 4.5 1.5 versicolor -#> 4: 6.0 2.2 5.0 1.5 virginica -#> 5: 4.5 2.3 1.3 0.3 setosa -#> --- -#> 146: 5.4 3.9 1.7 0.4 setosa -#> 147: 5.8 4.0 1.2 0.2 setosa -#> 148: 5.2 4.1 1.5 0.1 setosa -#> 149: 5.5 4.2 1.4 0.2 setosa -#> 150: 5.7 4.4 1.5 0.4 setosaa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 5.0 2.0 3.5 1.0 versicolor -#> 2: 6.0 2.2 4.0 1.0 versicolor -#> 3: 6.2 2.2 4.5 1.5 versicolor -#> 4: 6.0 2.2 5.0 1.5 virginica -#> 5: 4.5 2.3 1.3 0.3 setosa -#> --- -#> 146: 5.4 3.9 1.7 0.4 setosa -#> 147: 5.8 4.0 1.2 0.2 setosa -#> 148: 5.2 4.1 1.5 0.1 setosa -#> 149: 5.5 4.2 1.4 0.2 setosa -#> 150: 5.7 4.4 1.5 0.4 setosa-
+
+
Examples
+
+a = as.data.table(iris)
+a %>% arrange(Sepal.Length)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 4.3 3.0 1.1 0.1 setosa
+#> 2: 4.4 2.9 1.4 0.2 setosa
+#> 3: 4.4 3.0 1.3 0.2 setosa
+#> 4: 4.4 3.2 1.3 0.2 setosa
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 7.7 3.8 6.7 2.2 virginica
+#> 147: 7.7 2.6 6.9 2.3 virginica
+#> 148: 7.7 2.8 6.7 2.0 virginica
+#> 149: 7.7 3.0 6.1 2.3 virginica
+#> 150: 7.9 3.8 6.4 2.0 virginica
+a
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 4.3 3.0 1.1 0.1 setosa
+#> 2: 4.4 2.9 1.4 0.2 setosa
+#> 3: 4.4 3.0 1.3 0.2 setosa
+#> 4: 4.4 3.2 1.3 0.2 setosa
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 7.7 3.8 6.7 2.2 virginica
+#> 147: 7.7 2.6 6.9 2.3 virginica
+#> 148: 7.7 2.8 6.7 2.0 virginica
+#> 149: 7.7 3.0 6.1 2.3 virginica
+#> 150: 7.9 3.8 6.4 2.0 virginica
+a %>% arrange(cols = c("Sepal.Width","Petal.Length"))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.0 2.0 3.5 1.0 versicolor
+#> 2: 6.0 2.2 4.0 1.0 versicolor
+#> 3: 6.2 2.2 4.5 1.5 versicolor
+#> 4: 6.0 2.2 5.0 1.5 virginica
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 5.4 3.9 1.7 0.4 setosa
+#> 147: 5.8 4.0 1.2 0.2 setosa
+#> 148: 5.2 4.1 1.5 0.1 setosa
+#> 149: 5.5 4.2 1.4 0.2 setosa
+#> 150: 5.7 4.4 1.5 0.4 setosa
+a
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.0 2.0 3.5 1.0 versicolor
+#> 2: 6.0 2.2 4.0 1.0 versicolor
+#> 3: 6.2 2.2 4.5 1.5 versicolor
+#> 4: 6.0 2.2 5.0 1.5 virginica
+#> 5: 4.5 2.3 1.3 0.3 setosa
+#> ---
+#> 146: 5.4 3.9 1.7 0.4 setosa
+#> 147: 5.8 4.0 1.2 0.2 setosa
+#> 148: 5.2 4.1 1.5 0.1 setosa
+#> 149: 5.5 4.2 1.4 0.2 setosa
+#> 150: 5.7 4.4 1.5 0.4 setosa
+
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/complete.html b/docs/reference/complete.html
index 2dce3ea..0d9cfee 100644
--- a/docs/reference/complete.html
+++ b/docs/reference/complete.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-
+
-
+
+
-
@@ -136,72 +61,70 @@
- Save a data.frame as a fst table
and then parse it back as a fst table (class name is "fst_table").as_fst(.data)+
+
+
- as_fst(.data)Arguments
-| .data | -A data.frame |
-
|---|
+
-
+ Arguments
-Value
-An object of class fst_table
- .data +
A data.frame
-
Examples
---# \donttest{ - iris %>% - as_fst() -> iris_fst - iris_fst#> <fst file> -#> 150 rows, 5 columns (.a5445415a58.fst) -#> -#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <double> <double> <double> <double> <factor> -#> 1 5.1 3.5 1.4 0.2 setosa -#> 2 4.9 3.0 1.4 0.2 setosa -#> 3 4.7 3.2 1.3 0.2 setosa -#> 4 4.6 3.1 1.5 0.2 setosa -#> 5 5.0 3.6 1.4 0.2 setosa -#> -- -- -- -- -- -- -#> 146 6.7 3.0 5.2 2.3 virginica -#> 147 6.3 2.5 5.0 1.9 virginica -#> 148 6.5 3.0 5.2 2.0 virginica -#> 149 6.2 3.4 5.4 2.3 virginica -#> 150 5.9 3.0 5.1 1.8 virginica# } -
+
+ Value
+An object of class fst_table
+
+
Examples
+
+# \donttest{
+ iris %>%
+ as_fst() -> iris_fst
+ iris_fst
+#> <fst file>
+#> 150 rows, 5 columns (.27606c92540e.fst)
+#>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <double> <double> <double> <double> <factor>
+#> 1 5.1 3.5 1.4 0.2 setosa
+#> 2 4.9 3.0 1.4 0.2 setosa
+#> 3 4.7 3.2 1.3 0.2 setosa
+#> 4 4.6 3.1 1.5 0.2 setosa
+#> 5 5.0 3.6 1.4 0.2 setosa
+#> -- -- -- -- -- --
+#> 146 6.7 3.0 5.2 2.3 virginica
+#> 147 6.3 2.5 5.0 1.9 virginica
+#> 148 6.5 3.0 5.2 2.0 virginica
+#> 149 6.2 3.4 5.4 2.3 virginica
+#> 150 5.9 3.0 5.1 1.8 virginica
+# }
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/count.html b/docs/reference/count.html
index 895be5a..0f6fe7e 100644
--- a/docs/reference/count.html
+++ b/docs/reference/count.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-
+
@@ -136,150 +61,158 @@
-
+
- Complete a data frame with missing combinations of data
- Source:R/complete.R
+ Source: R/complete.R
complete.RdComplete a data frame with missing combinations of data
Analogous function forcomplete function in tidyr.
complete(.data, ..., fill = NA)+
+
+
+
+ complete(.data, ..., fill = NA)
+
-
+find more details in examples.
- fill
+
+ Arguments
-Arguments
-| .data | -data.frame |
-
|---|---|
| ... | -Specification of columns to expand.The selection of columns is
-supported by the flexible
|
-
| fill | -Atomic value to fill into the missing cell, default uses |
-
Value
-data.table
-Details
+Atomic value to fill into the missing cell, default uses NA.
+
+ Value
+data.table
+
+
-
+ Details
When the provided columns with addtion data are of different length, all the unique combinations would be returned. This operation should be used only on unique entries, and it will always returned the unique entries.
If you supply fill parameter, these values will also replace existing explicit missing values in the data set.
-See also
- - - -Examples
--df <- data.table( - group = c(1:2, 1), - item_id = c(1:2, 2), - item_name = c("a", "b", "b"), - value1 = 1:3, - value2 = 4:6 -) - -df %>% complete(item_id,item_name)#> Key: <item_id, item_name> -#> item_id item_name group value1 value2 -#> <num> <char> <num> <int> <int> -#> 1: 1 a 1 1 4 -#> 2: 1 b NA NA NA -#> 3: 2 a NA NA NA -#> 4: 2 b 2 2 5 -#> 5: 2 b 1 3 6df %>% complete(item_id,item_name,fill = 0)#> Key: <item_id, item_name> -#> item_id item_name group value1 value2 -#> <num> <char> <num> <int> <int> -#> 1: 1 a 1 1 4 -#> 2: 1 b 0 0 0 -#> 3: 2 a 0 0 0 -#> 4: 2 b 2 2 5 -#> 5: 2 b 1 3 6df %>% complete("item")#> Key: <item_id, item_name> -#> item_id item_name group value1 value2 -#> <num> <char> <num> <int> <int> -#> 1: 1 a 1 1 4 -#> 2: 1 b NA NA NA -#> 3: 2 a NA NA NA -#> 4: 2 b 2 2 5 -#> 5: 2 b 1 3 6df %>% complete(item_id=1:3)#> Key: <item_id> -#> item_id group item_name value1 value2 -#> <int> <num> <char> <int> <int> -#> 1: 1 1 a 1 4 -#> 2: 2 2 b 2 5 -#> 3: 2 1 b 3 6 -#> 4: 3 NA <NA> NA NAdf %>% complete(item_id=1:3,group=1:2)#> Key: <item_id, group> -#> item_id group item_name value1 value2 -#> <int> <int> <char> <int> <int> -#> 1: 1 1 a 1 4 -#> 2: 1 2 <NA> NA NA -#> 3: 2 1 b 3 6 -#> 4: 2 2 b 2 5 -#> 5: 3 1 <NA> NA NA -#> 6: 3 2 <NA> NA NA#> Key: <item_id, group, item_name> -#> item_id group item_name value1 value2 -#> <int> <int> <char> <int> <int> -#> 1: 1 1 a 1 4 -#> 2: 1 1 b NA NA -#> 3: 1 1 c NA NA -#> 4: 1 2 a NA NA -#> 5: 1 2 b NA NA -#> 6: 1 2 c NA NA -#> 7: 1 3 a NA NA -#> 8: 1 3 b NA NA -#> 9: 1 3 c NA NA -#> 10: 2 1 a NA NA -#> 11: 2 1 b 3 6 -#> 12: 2 1 c NA NA -#> 13: 2 2 a NA NA -#> 14: 2 2 b 2 5 -#> 15: 2 2 c NA NA -#> 16: 2 3 a NA NA -#> 17: 2 3 b NA NA -#> 18: 2 3 c NA NA -#> 19: 3 1 a NA NA -#> 20: 3 1 b NA NA -#> 21: 3 1 c NA NA -#> 22: 3 2 a NA NA -#> 23: 3 2 b NA NA -#> 24: 3 2 c NA NA -#> 25: 3 3 a NA NA -#> 26: 3 3 b NA NA -#> 27: 3 3 c NA NA -#> item_id group item_name value1 value2-
+
+ See also
+ +
+
+
Examples
+df <- data.table(
+ group = c(1:2, 1),
+ item_id = c(1:2, 2),
+ item_name = c("a", "b", "b"),
+ value1 = 1:3,
+ value2 = 4:6
+)
+
+df %>% complete(item_id,item_name)
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b NA NA NA
+#> 3: 2 a NA NA NA
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete(item_id,item_name,fill = 0)
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b 0 0 0
+#> 3: 2 a 0 0 0
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete("item")
+#> Key: <item_id, item_name>
+#> item_id item_name group value1 value2
+#> <num> <char> <num> <int> <int>
+#> 1: 1 a 1 1 4
+#> 2: 1 b NA NA NA
+#> 3: 2 a NA NA NA
+#> 4: 2 b 2 2 5
+#> 5: 2 b 1 3 6
+df %>% complete(item_id=1:3)
+#> Key: <item_id>
+#> item_id group item_name value1 value2
+#> <int> <num> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 2 2 b 2 5
+#> 3: 2 1 b 3 6
+#> 4: 3 NA <NA> NA NA
+df %>% complete(item_id=1:3,group=1:2)
+#> Key: <item_id, group>
+#> item_id group item_name value1 value2
+#> <int> <int> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 1 2 <NA> NA NA
+#> 3: 2 1 b 3 6
+#> 4: 2 2 b 2 5
+#> 5: 3 1 <NA> NA NA
+#> 6: 3 2 <NA> NA NA
+df %>% complete(item_id=1:3,group=1:3,item_name=c("a","b","c"))
+#> Key: <item_id, group, item_name>
+#> item_id group item_name value1 value2
+#> <int> <int> <char> <int> <int>
+#> 1: 1 1 a 1 4
+#> 2: 1 1 b NA NA
+#> 3: 1 1 c NA NA
+#> 4: 1 2 a NA NA
+#> 5: 1 2 b NA NA
+#> 6: 1 2 c NA NA
+#> 7: 1 3 a NA NA
+#> 8: 1 3 b NA NA
+#> 9: 1 3 c NA NA
+#> 10: 2 1 a NA NA
+#> 11: 2 1 b 3 6
+#> 12: 2 1 c NA NA
+#> 13: 2 2 a NA NA
+#> 14: 2 2 b 2 5
+#> 15: 2 2 c NA NA
+#> 16: 2 3 a NA NA
+#> 17: 2 3 b NA NA
+#> 18: 2 3 c NA NA
+#> 19: 3 1 a NA NA
+#> 20: 3 1 b NA NA
+#> 21: 3 1 c NA NA
+#> 22: 3 2 a NA NA
+#> 23: 3 2 b NA NA
+#> 24: 3 2 c NA NA
+#> 25: 3 3 a NA NA
+#> 26: 3 3 b NA NA
+#> 27: 3 3 c NA NA
+#> item_id group item_name value1 value2
+
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/cummean.html b/docs/reference/cummean.html
index 5d73212..bd15ddf 100644
--- a/docs/reference/cummean.html
+++ b/docs/reference/cummean.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-
+
-
-
-
+
-
@@ -134,135 +59,141 @@
- Count observations by group
Analogous function for count and add_count in dplyr.
count(.data, ..., sort = FALSE, name = "n") - -add_count(.data, ..., name = "n")- -
Arguments
-| .data | -data.table |
-
|---|---|
| ... | -variables to group by. |
-
| sort | -logical. If TRUE result will be sorted in desending order by resulting variable. |
-
| name | -character. Name of resulting variable. Default uses "n". |
-
Value
+
+
+
+
+ count(.data, ..., sort = FALSE, name = "n")
+
+add_count(.data, ..., name = "n")
+
-
+ Arguments
-data.table
-Examples
--#> cyl n -#> <num> <int> -#> 1: 6 7 -#> 2: 4 11 -#> 3: 8 14count(a,cyl,sort = TRUE)#> cyl n -#> <num> <int> -#> 1: 8 14 -#> 2: 4 11 -#> 3: 6 7a#> mpg cyl disp hp drat wt qsec vs am gear carb -#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> -#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4 -#> 2: 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4 -#> 3: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1 -#> 4: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1 -#> 5: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2 -#> 6: 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1 -#> 7: 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4 -#> 8: 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2 -#> 9: 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2 -#> 10: 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4 -#> 11: 17.8 6 167.6 123 3.92 3.440 18.90 1 0 4 4 -#> 12: 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3 -#> 13: 17.3 8 275.8 180 3.07 3.730 17.60 0 0 3 3 -#> 14: 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3 -#> 15: 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4 -#> 16: 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4 -#> 17: 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4 -#> 18: 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1 -#> 19: 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2 -#> 20: 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1 -#> 21: 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1 -#> 22: 15.5 8 318.0 150 2.76 3.520 16.87 0 0 3 2 -#> 23: 15.2 8 304.0 150 3.15 3.435 17.30 0 0 3 2 -#> 24: 13.3 8 350.0 245 3.73 3.840 15.41 0 0 3 4 -#> 25: 19.2 8 400.0 175 3.08 3.845 17.05 0 0 3 2 -#> 26: 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1 -#> 27: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2 -#> 28: 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2 -#> 29: 15.8 8 351.0 264 4.22 3.170 14.50 0 1 5 4 -#> 30: 19.7 6 145.0 175 3.62 2.770 15.50 0 1 5 6 -#> 31: 15.0 8 301.0 335 3.54 3.570 14.60 0 1 5 8 -#> 32: 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2 -#> mpg cyl disp hp drat wt qsec vs am gear carb#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N -#> <num> <num> <num> <num> <fctr> <int> -#> 1: 5.1 3.5 1.4 0.2 setosa 50 -#> 2: 4.9 3.0 1.4 0.2 setosa 50 -#> 3: 4.7 3.2 1.3 0.2 setosa 50 -#> 4: 4.6 3.1 1.5 0.2 setosa 50 -#> 5: 5.0 3.6 1.4 0.2 setosa 50 -#> --- -#> 146: 6.7 3.0 5.2 2.3 virginica 50 -#> 147: 6.3 2.5 5.0 1.9 virginica 50 -#> 148: 6.5 3.0 5.2 2.0 virginica 50 -#> 149: 6.2 3.4 5.4 2.3 virginica 50 -#> 150: 5.9 3.0 5.1 1.8 virginica 50b#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N -#> <num> <num> <num> <num> <fctr> <int> -#> 1: 5.1 3.5 1.4 0.2 setosa 50 -#> 2: 4.9 3.0 1.4 0.2 setosa 50 -#> 3: 4.7 3.2 1.3 0.2 setosa 50 -#> 4: 4.6 3.1 1.5 0.2 setosa 50 -#> 5: 5.0 3.6 1.4 0.2 setosa 50 -#> --- -#> 146: 6.7 3.0 5.2 2.3 virginica 50 -#> 147: 6.3 2.5 5.0 1.9 virginica 50 -#> 148: 6.5 3.0 5.2 2.0 virginica 50 -#> 149: 6.2 3.4 5.4 2.3 virginica 50 -#> 150: 5.9 3.0 5.1 1.8 virginica 50
+
+
+ Value
+data.table
+
+
+
Examples
+a = as.data.table(mtcars)
+count(a,cyl)
+#> cyl n
+#> <num> <int>
+#> 1: 6 7
+#> 2: 4 11
+#> 3: 8 14
+count(a,cyl,sort = TRUE)
+#> cyl n
+#> <num> <int>
+#> 1: 8 14
+#> 2: 4 11
+#> 3: 6 7
+a
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
+#> 2: 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
+#> 3: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
+#> 4: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
+#> 5: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
+#> 6: 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1
+#> 7: 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4
+#> 8: 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
+#> 9: 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
+#> 10: 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4
+#> 11: 17.8 6 167.6 123 3.92 3.440 18.90 1 0 4 4
+#> 12: 16.4 8 275.8 180 3.07 4.070 17.40 0 0 3 3
+#> 13: 17.3 8 275.8 180 3.07 3.730 17.60 0 0 3 3
+#> 14: 15.2 8 275.8 180 3.07 3.780 18.00 0 0 3 3
+#> 15: 10.4 8 472.0 205 2.93 5.250 17.98 0 0 3 4
+#> 16: 10.4 8 460.0 215 3.00 5.424 17.82 0 0 3 4
+#> 17: 14.7 8 440.0 230 3.23 5.345 17.42 0 0 3 4
+#> 18: 32.4 4 78.7 66 4.08 2.200 19.47 1 1 4 1
+#> 19: 30.4 4 75.7 52 4.93 1.615 18.52 1 1 4 2
+#> 20: 33.9 4 71.1 65 4.22 1.835 19.90 1 1 4 1
+#> 21: 21.5 4 120.1 97 3.70 2.465 20.01 1 0 3 1
+#> 22: 15.5 8 318.0 150 2.76 3.520 16.87 0 0 3 2
+#> 23: 15.2 8 304.0 150 3.15 3.435 17.30 0 0 3 2
+#> 24: 13.3 8 350.0 245 3.73 3.840 15.41 0 0 3 4
+#> 25: 19.2 8 400.0 175 3.08 3.845 17.05 0 0 3 2
+#> 26: 27.3 4 79.0 66 4.08 1.935 18.90 1 1 4 1
+#> 27: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
+#> 28: 30.4 4 95.1 113 3.77 1.513 16.90 1 1 5 2
+#> 29: 15.8 8 351.0 264 4.22 3.170 14.50 0 1 5 4
+#> 30: 19.7 6 145.0 175 3.62 2.770 15.50 0 1 5 6
+#> 31: 15.0 8 301.0 335 3.54 3.570 14.60 0 1 5 8
+#> 32: 21.4 4 121.0 109 4.11 2.780 18.60 1 1 4 2
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+
+b = as.data.table(iris)
+b %>% add_count(Species,name = "N")
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
+#> <num> <num> <num> <num> <fctr> <int>
+#> 1: 5.1 3.5 1.4 0.2 setosa 50
+#> 2: 4.9 3.0 1.4 0.2 setosa 50
+#> 3: 4.7 3.2 1.3 0.2 setosa 50
+#> 4: 4.6 3.1 1.5 0.2 setosa 50
+#> 5: 5.0 3.6 1.4 0.2 setosa 50
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica 50
+#> 147: 6.3 2.5 5.0 1.9 virginica 50
+#> 148: 6.5 3.0 5.2 2.0 virginica 50
+#> 149: 6.2 3.4 5.4 2.3 virginica 50
+#> 150: 5.9 3.0 5.1 1.8 virginica 50
+b
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species N
+#> <num> <num> <num> <num> <fctr> <int>
+#> 1: 5.1 3.5 1.4 0.2 setosa 50
+#> 2: 4.9 3.0 1.4 0.2 setosa 50
+#> 3: 4.7 3.2 1.3 0.2 setosa 50
+#> 4: 4.6 3.1 1.5 0.2 setosa 50
+#> 5: 5.0 3.6 1.4 0.2 setosa 50
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica 50
+#> 147: 6.3 2.5 5.0 1.9 virginica 50
+#> 148: 6.5 3.0 5.2 2.0 virginica 50
+#> 149: 6.2 3.4 5.4 2.3 virginica 50
+#> 150: 5.9 3.0 5.1 1.8 virginica 50
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/distinct.html b/docs/reference/distinct.html
index 2ef71bc..f89f37f 100644
--- a/docs/reference/distinct.html
+++ b/docs/reference/distinct.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-
+
-
+
-
+
+
-
@@ -134,54 +59,52 @@
- Cumulative mean
Returns a vector whose elements are the cumulative mean of the elements of the argument.
cummean(x)+
+
+
- cummean(x)Arguments
-| x | -a numeric or complex object, -or an object that can be coerced to one of these. |
-
|---|
+
+ Value
+A numeric vector
+
+
+
Examples
+cummean(1:10)
+#> [1] 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0 5.5
+
+
-
-
-
-
-
-
+
-
+If omitted, will use all variables.
+
- .keep_all
+
+
@@ -134,83 +59,83 @@
- Select distinct/unique rows in data.table
Analogous function for distinct in dplyr
distinct(.data, ..., .keep_all = FALSE)- -
Arguments
-| .data | -data.table |
-
|---|---|
| ... | -Optional variables to use when determining uniqueness. +
+
+
+ |
-
| .keep_all | -If |
-
Value
+If TRUE, keep all variables in data.table. If a combination of ... is not distinct,
+this keeps the first row of values.
+
-
+ Value
data.table
-See also
- - - -Examples
--#> Species -#> <fctr> -#> 1: setosa -#> 2: versicolor -#> 3: virginicab %>% distinct(cyl,vs,.keep_all = TRUE)#> mpg cyl disp hp drat wt qsec vs am gear carb -#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> -#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4 -#> 2: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1 -#> 3: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1 -#> 4: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2 -#> 5: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2- -
+
+ See also
+ +
+
+
Examples
+
+ a = as.data.table(iris)
+ b = as.data.table(mtcars)
+ a %>% distinct(Species)
+#> Species
+#> <fctr>
+#> 1: setosa
+#> 2: versicolor
+#> 3: virginica
+ b %>% distinct(cyl,vs,.keep_all = TRUE)
+#> mpg cyl disp hp drat wt qsec vs am gear carb
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
+#> 2: 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
+#> 3: 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
+#> 4: 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
+#> 5: 26.0 4 120.3 91 4.43 2.140 16.70 0 1 5 2
+
+
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/dummy.html b/docs/reference/dummy.html
index 9a1d3b6..617b998 100644
--- a/docs/reference/dummy.html
+++ b/docs/reference/dummy.html
@@ -1,73 +1,13 @@
-
-
-
-
-
-
-
-
+
@@ -136,104 +61,114 @@
-
-
+
+
- Drop or delete data by rows or columns
- Source:R/drop_delete_na.R
+ Source: R/drop_delete_na.R
drop_delete_na.RdDrop or delete data by rows or columns
delete_na deletes rows or columns with too many NAs.
drop_na(.data, ...) - -delete_na(.data, MARGIN, n)- -
Arguments
-| .data | -A data.table |
-
|---|---|
| ... | -Colunms to be dropped or deleted. |
-
| MARGIN | -1 or 2. 1 for deleting rows, 2 for deleting columns. |
-
| n | -If number (proportion) of NAs is larger than or equal to "n", -the columns/rows would be deleted. When smaller than 1, use as proportion. -When larger or equal to 1, use as number. |
-
+
+
- drop_na(.data, ...)
+
+delete_na(.data, MARGIN, n)Value
+
+
-
+ Arguments
-A data.table
-Examples
--#> x y z -#> <num> <num> <lgcl> -#> 1: 1 NA NA -#> 2: 2 NA NA -#> 3: NA 4 NA -#> 4: 3 5 NAx %>% delete_na(2,0.75)#> x y -#> <num> <num> -#> 1: 1 NA -#> 2: 2 NA -#> 3: NA 4 -#> 4: 3 5#> x -#> <num> -#> 1: 1 -#> 2: 2 -#> 3: NA -#> 4: 3#> Null data.table (0 rows and 0 cols)#> x -#> <num> -#> 1: 1 -#> 2: 2 -#> 3: NA -#> 4: 3#> x y z -#> <num> <num> <lgcl> -#> 1: 3 5 NA#> x y z -#> <num> <num> <lgcl> -#> 1: 3 5 NA- -
+
+
+ Value
+A data.table
+
+
+
Examples
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 1 NA NA
+#> 2: 2 NA NA
+#> 3: NA 4 NA
+#> 4: 3 5 NA
+x %>% delete_na(2,0.75)
+#> x y
+#> <num> <num>
+#> 1: 1 NA
+#> 2: 2 NA
+#> 3: NA 4
+#> 4: 3 5
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,0.5)
+#> x
+#> <num>
+#> 1: 1
+#> 2: 2
+#> 3: NA
+#> 4: 3
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,0.24)
+#> Null data.table (0 rows and 0 cols)
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(2,2)
+#> x
+#> <num>
+#> 1: 1
+#> 2: 2
+#> 3: NA
+#> 4: 3
+
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(1,0.6)
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 3 5 NA
+x = data.table(x = c(1, 2, NA, 3), y = c(NA, NA, 4, 5),z = rep(NA,4))
+x %>% delete_na(1,2)
+#> x y z
+#> <num> <num> <lgcl>
+#> 1: 3 5 NA
+
+
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/fill.html b/docs/reference/fill.html
index 83680bc..c38eda6 100644
--- a/docs/reference/fill.html
+++ b/docs/reference/fill.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-
+
+
-
@@ -136,162 +61,166 @@
- Fast creation of dummy variables
This function is useful for statistical analysis when you want binary columns rather than character columns.dummy(.data, ..., longname = TRUE)+
+
+
+
+ dummy(.data, ..., longname = TRUE)
+
-
-
+ Arguments
-Arguments
-| .data | -data.frame |
-
|---|---|
| ... | -Columns you want to create dummy variables from. -Very flexible, find in the examples. |
-
| longname | -logical. Should the output column labeled with the
-original column name? Default uses |
-
Value
+
+
+ Value
+data.table
+
+
-
+ Details
If no columns provided, will return the original data frame.
This function is inspired by fastDummies package, but provides
-simple and precise usage, whereas fastDummies::dummy_cols provides more
+simple and precise usage, whereas fastDummies::dummy_cols provides more
features for statistical usage.
See also
- - - -Examples
--#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width> -#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species_setosa -#> <num> <num> <num> <num> <num> -#> 1: 4.3 3.0 1.1 0.1 1 -#> 2: 4.4 2.9 1.4 0.2 1 -#> 3: 4.4 3.0 1.3 0.2 1 -#> 4: 4.4 3.2 1.3 0.2 1 -#> 5: 4.5 2.3 1.3 0.3 1 -#> --- -#> 146: 7.7 2.6 6.9 2.3 0 -#> 147: 7.7 2.8 6.7 2.0 0 -#> 148: 7.7 3.0 6.1 2.3 0 -#> 149: 7.7 3.8 6.7 2.2 0 -#> 150: 7.9 3.8 6.4 2.0 0 -#> Species_versicolor Species_virginica -#> <num> <num> -#> 1: 0 0 -#> 2: 0 0 -#> 3: 0 0 -#> 4: 0 0 -#> 5: 0 0 -#> --- -#> 146: 0 1 -#> 147: 0 1 -#> 148: 0 1 -#> 149: 0 1 -#> 150: 0 1iris %>% dummy(Species,longname = FALSE)#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width> -#> Sepal.Length Sepal.Width Petal.Length Petal.Width setosa versicolor -#> <num> <num> <num> <num> <num> <num> -#> 1: 4.3 3.0 1.1 0.1 1 0 -#> 2: 4.4 2.9 1.4 0.2 1 0 -#> 3: 4.4 3.0 1.3 0.2 1 0 -#> 4: 4.4 3.2 1.3 0.2 1 0 -#> 5: 4.5 2.3 1.3 0.3 1 0 -#> --- -#> 146: 7.7 2.6 6.9 2.3 0 0 -#> 147: 7.7 2.8 6.7 2.0 0 0 -#> 148: 7.7 3.0 6.1 2.3 0 0 -#> 149: 7.7 3.8 6.7 2.2 0 0 -#> 150: 7.9 3.8 6.4 2.0 0 0 -#> virginica -#> <num> -#> 1: 0 -#> 2: 0 -#> 3: 0 -#> 4: 0 -#> 5: 0 -#> --- -#> 146: 1 -#> 147: 1 -#> 148: 1 -#> 149: 1 -#> 150: 1#> Key: <mpg, cyl, disp, hp, drat, wt, qsec, gear, carb, vs_0, vs_1> -#> mpg cyl disp hp drat wt qsec gear carb vs_0 vs_1 am_0 -#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> -#> 1: 18.1 6 225 105 2.76 3.460 20.22 3 1 0 1 1 -#> 2: 18.7 8 360 175 3.15 3.440 17.02 3 2 1 0 1 -#> 3: 21.0 6 160 110 3.90 2.620 16.46 4 4 1 0 0 -#> 4: 21.0 6 160 110 3.90 2.875 17.02 4 4 1 0 0 -#> 5: 21.4 6 258 110 3.08 3.215 19.44 3 1 0 1 1 -#> 6: 22.8 4 108 93 3.85 2.320 18.61 4 1 0 1 0 -#> am_1 -#> <num> -#> 1: 0 -#> 2: 0 -#> 3: 1 -#> 4: 1 -#> 5: 0 -#> 6: 1#> Key: <mpg, disp, hp, drat, wt, qsec, vs, am, carb, cyl_4, cyl_6, cyl_8> -#> mpg disp hp drat wt qsec vs am carb cyl_4 cyl_6 cyl_8 -#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> -#> 1: 18.1 225 105 2.76 3.460 20.22 1 0 1 0 1 0 -#> 2: 18.7 360 175 3.15 3.440 17.02 0 0 2 0 0 1 -#> 3: 21.0 160 110 3.90 2.620 16.46 0 1 4 0 1 0 -#> 4: 21.0 160 110 3.90 2.875 17.02 0 1 4 0 1 0 -#> 5: 21.4 258 110 3.08 3.215 19.44 1 0 1 0 1 0 -#> 6: 22.8 108 93 3.85 2.320 18.61 1 1 1 1 0 0 -#> gear_3 gear_4 -#> <num> <num> -#> 1: 1 0 -#> 2: 1 0 -#> 3: 0 1 -#> 4: 0 1 -#> 5: 1 0 -#> 6: 0 1-
+
+
+ See also
+dummy_cols
+
+
Examples
+
+iris = as.data.table(iris)
+iris %>% dummy(Species)
+#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species_setosa
+#> <num> <num> <num> <num> <num>
+#> 1: 4.3 3.0 1.1 0.1 1
+#> 2: 4.4 2.9 1.4 0.2 1
+#> 3: 4.4 3.0 1.3 0.2 1
+#> 4: 4.4 3.2 1.3 0.2 1
+#> 5: 4.5 2.3 1.3 0.3 1
+#> ---
+#> 146: 7.7 2.6 6.9 2.3 0
+#> 147: 7.7 2.8 6.7 2.0 0
+#> 148: 7.7 3.0 6.1 2.3 0
+#> 149: 7.7 3.8 6.7 2.2 0
+#> 150: 7.9 3.8 6.4 2.0 0
+#> Species_versicolor Species_virginica
+#> <num> <num>
+#> 1: 0 0
+#> 2: 0 0
+#> 3: 0 0
+#> 4: 0 0
+#> 5: 0 0
+#> ---
+#> 146: 0 1
+#> 147: 0 1
+#> 148: 0 1
+#> 149: 0 1
+#> 150: 0 1
+iris %>% dummy(Species,longname = FALSE)
+#> Key: <Sepal.Length, Sepal.Width, Petal.Length, Petal.Width>
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width setosa versicolor
+#> <num> <num> <num> <num> <num> <num>
+#> 1: 4.3 3.0 1.1 0.1 1 0
+#> 2: 4.4 2.9 1.4 0.2 1 0
+#> 3: 4.4 3.0 1.3 0.2 1 0
+#> 4: 4.4 3.2 1.3 0.2 1 0
+#> 5: 4.5 2.3 1.3 0.3 1 0
+#> ---
+#> 146: 7.7 2.6 6.9 2.3 0 0
+#> 147: 7.7 2.8 6.7 2.0 0 0
+#> 148: 7.7 3.0 6.1 2.3 0 0
+#> 149: 7.7 3.8 6.7 2.2 0 0
+#> 150: 7.9 3.8 6.4 2.0 0 0
+#> virginica
+#> <num>
+#> 1: 0
+#> 2: 0
+#> 3: 0
+#> 4: 0
+#> 5: 0
+#> ---
+#> 146: 1
+#> 147: 1
+#> 148: 1
+#> 149: 1
+#> 150: 1
+
+mtcars = as.data.table(mtcars)
+mtcars %>% head() %>% dummy(vs,am)
+#> Key: <mpg, cyl, disp, hp, drat, wt, qsec, gear, carb, vs_0, vs_1>
+#> mpg cyl disp hp drat wt qsec gear carb vs_0 vs_1 am_0
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 18.1 6 225 105 2.76 3.460 20.22 3 1 0 1 1
+#> 2: 18.7 8 360 175 3.15 3.440 17.02 3 2 1 0 1
+#> 3: 21.0 6 160 110 3.90 2.620 16.46 4 4 1 0 0
+#> 4: 21.0 6 160 110 3.90 2.875 17.02 4 4 1 0 0
+#> 5: 21.4 6 258 110 3.08 3.215 19.44 3 1 0 1 1
+#> 6: 22.8 4 108 93 3.85 2.320 18.61 4 1 0 1 0
+#> am_1
+#> <num>
+#> 1: 0
+#> 2: 0
+#> 3: 1
+#> 4: 1
+#> 5: 0
+#> 6: 1
+mtcars %>% head() %>% dummy("cyl|gear")
+#> Key: <mpg, disp, hp, drat, wt, qsec, vs, am, carb, cyl_4, cyl_6, cyl_8>
+#> mpg disp hp drat wt qsec vs am carb cyl_4 cyl_6 cyl_8
+#> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num> <num>
+#> 1: 18.1 225 105 2.76 3.460 20.22 1 0 1 0 1 0
+#> 2: 18.7 360 175 3.15 3.440 17.02 0 0 2 0 0 1
+#> 3: 21.0 160 110 3.90 2.620 16.46 0 1 4 0 1 0
+#> 4: 21.0 160 110 3.90 2.875 17.02 0 1 4 0 1 0
+#> 5: 21.4 258 110 3.08 3.215 19.44 1 0 1 0 1 0
+#> 6: 22.8 108 93 3.85 2.320 18.61 1 1 1 1 0 0
+#> gear_3 gear_4
+#> <num> <num>
+#> 1: 1 0
+#> 2: 1 0
+#> 3: 0 1
+#> 4: 0 1
+#> 5: 1 0
+#> 6: 0 1
+
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/filter.html b/docs/reference/filter.html
index ae0be81..e8d10dc 100644
--- a/docs/reference/filter.html
+++ b/docs/reference/filter.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-
+
-
-
-
-
+
-
@@ -134,116 +59,118 @@
- Fill in missing values with previous or next value
Fills missing values in selected columns using the next or previous entry.
fill(.data, ..., direction = "down") - -shift_fill(x, direction = "down")- -
Arguments
-| .data | -A data.table |
-
|---|---|
| ... | -A selection of columns. |
-
| direction | -Direction in which to fill missing values. -Currently either "down" (the default), "up". |
-
| x | -A vector. |
-
Value
+
+
+
- fill(.data, ..., direction = "down")
+
+shift_fill(x, direction = "down")A filled data.table
-Details
+
+
+ Arguments
+ + +
+
+ Value
+A filled data.table
+
+
- Details
fill is filling data.table's columns,
shift_fill is filling any vectors.
Examples
--#> Month Year -#> <int> <num> -#> 1: 1 2000 -#> 2: 2 NA -#> 3: 3 NA -#> 4: 4 NA -#> 5: 5 NA -#> 6: 6 NA -#> 7: 7 NA -#> 8: 8 NA -#> 9: 9 NA -#> 10: 10 NA -#> 11: 11 NA -#> 12: 12 2001df %>% fill(Year)#> Month Year -#> <int> <num> -#> 1: 1 2000 -#> 2: 2 2000 -#> 3: 3 2000 -#> 4: 4 2000 -#> 5: 5 2000 -#> 6: 6 2000 -#> 7: 7 2000 -#> 8: 8 2000 -#> 9: 9 2000 -#> 10: 10 2000 -#> 11: 11 2000 -#> 12: 12 2001-df <- data.table(Month = 1:12, Year = c(2000, rep(NA, 10),2001)) -df %>% fill(Year,direction = "up")#> Month Year -#> <int> <num> -#> 1: 1 2000 -#> 2: 2 2001 -#> 3: 3 2001 -#> 4: 4 2001 -#> 5: 5 2001 -#> 6: 6 2001 -#> 7: 7 2001 -#> 8: 8 2001 -#> 9: 9 2001 -#> 10: 10 2001 -#> 11: 11 2001 -#> 12: 12 2001-
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/fst.html b/docs/reference/fst.html
index d973203..76cc349 100644
--- a/docs/reference/fst.html
+++ b/docs/reference/fst.html
@@ -1,72 +1,12 @@
-
-
-
-
-
-
-
-
+
-
+
+
+
-
@@ -134,96 +59,100 @@
- Filter entries in data.frame
Analogous function for filter in dplyr.
filter(.data, ...)+
+
+
- filter(.data, ...)Arguments
-| .data | -data.frame |
-
|---|---|
| ... | -List of variables or name-value pairs of summary/modifications -functions. |
-
+
+ Value
+A data.table
+
+
-
+ Details
Currently data.table is not able to delete rows by reference,
-References
- -https://github.com/Rdatatable/data.table/issues/635
-https://stackoverflow.com/questions/10790204/how-to-delete-a-row-by-reference-in-data-table
-See also
- - - -Examples
--#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 7.1 3.0 5.9 2.1 virginica -#> 2: 7.6 3.0 6.6 2.1 virginica -#> 3: 7.3 2.9 6.3 1.8 virginica -#> 4: 7.2 3.6 6.1 2.5 virginica -#> 5: 7.7 3.8 6.7 2.2 virginica -#> 6: 7.7 2.6 6.9 2.3 virginica -#> 7: 7.7 2.8 6.7 2.0 virginica -#> 8: 7.2 3.2 6.0 1.8 virginica -#> 9: 7.2 3.0 5.8 1.6 virginica -#> 10: 7.4 2.8 6.1 1.9 virginica -#> 11: 7.9 3.8 6.4 2.0 virginica -#> 12: 7.7 3.0 6.1 2.3 virginicairis %>% filter(Sepal.Length > 7,Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 7.2 3.6 6.1 2.5 virginica -#> 2: 7.7 3.8 6.7 2.2 virginica -#> 3: 7.2 3.2 6.0 1.8 virginica -#> 4: 7.9 3.8 6.4 2.0 virginicairis %>% filter(Sepal.Length > 7 & Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 7.2 3.6 6.1 2.5 virginica -#> 2: 7.7 3.8 6.7 2.2 virginica -#> 3: 7.2 3.2 6.0 1.8 virginica -#> 4: 7.9 3.8 6.4 2.0 virginica#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 7.9 3.8 6.4 2 virginica
+
+ References
+https://github.com/Rdatatable/data.table/issues/635
+https://stackoverflow.com/questions/10790204/how-to-delete-a-row-by-reference-in-data-table
+
+
+ See also
+ +
+
+
Examples
+iris = as.data.table(iris)
+iris %>% filter(Sepal.Length > 7)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.1 3.0 5.9 2.1 virginica
+#> 2: 7.6 3.0 6.6 2.1 virginica
+#> 3: 7.3 2.9 6.3 1.8 virginica
+#> 4: 7.2 3.6 6.1 2.5 virginica
+#> 5: 7.7 3.8 6.7 2.2 virginica
+#> 6: 7.7 2.6 6.9 2.3 virginica
+#> 7: 7.7 2.8 6.7 2.0 virginica
+#> 8: 7.2 3.2 6.0 1.8 virginica
+#> 9: 7.2 3.0 5.8 1.6 virginica
+#> 10: 7.4 2.8 6.1 1.9 virginica
+#> 11: 7.9 3.8 6.4 2.0 virginica
+#> 12: 7.7 3.0 6.1 2.3 virginica
+iris %>% filter(Sepal.Length > 7,Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.2 3.6 6.1 2.5 virginica
+#> 2: 7.7 3.8 6.7 2.2 virginica
+#> 3: 7.2 3.2 6.0 1.8 virginica
+#> 4: 7.9 3.8 6.4 2.0 virginica
+iris %>% filter(Sepal.Length > 7 & Sepal.Width > 3)
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.2 3.6 6.1 2.5 virginica
+#> 2: 7.7 3.8 6.7 2.2 virginica
+#> 3: 7.2 3.2 6.0 1.8 virginica
+#> 4: 7.9 3.8 6.4 2.0 virginica
+iris %>% filter(Sepal.Length == max(Sepal.Length))
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 7.9 3.8 6.4 2 virginica
+
-
-
-
-
-
+
+
-
-
-
+
diff --git a/docs/reference/fst_io.html b/docs/reference/fst_io.html
index 68160fc..0b22969 100644
--- a/docs/reference/fst_io.html
+++ b/docs/reference/fst_io.html
@@ -1,74 +1,14 @@
-
-
-
-
-
-
-
-
+
+
-
@@ -134,366 +59,403 @@
- Parse,inspect and extract data.table from fst file
An API for reading fst file as data.table.
parse_fst(path) +++ ++parse_fst(path) + +slice_fst(ft, row_no) + +select_fst(ft, ...) + +filter_fst(ft, ...) + +summary_fst(ft)++Arguments
+ -slice_fst(ft, row_no) +
- path
+- -select_fst(ft, ...) -filter_fst(ft, ...) +
path to fst file
- ft
+- -summary_fst(ft) -
An object of class fst_table, returned by
parse_fstArguments
--
+- - -path -- path to fst file
- -ft -- An object of class fst_table, returned by
parse_fst- -row_no -- An integer vector (Positive)
- -... -- The filter conditions
- row_no
+- -
An integer vector (Positive)
Value
+- ...
+- + +
The filter conditions
++Value
parse_fstreturns a fst_table class.-
select_fstandfilter_fstreturns a data.table.Details
- ++- +Details
-
summary_fstcould provide some basic information about the fst table.See also
- - - -Examples
--- # write the file first - path = tempfile(fileext = ".fst") - fst::write_fst(iris,path) - # parse the file but not reading it - parse_fst(path) -> ft - - ft#> <fst file> -#> 150 rows, 5 columns (filea5434c14328.fst) -#> -#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <double> <double> <double> <double> <factor> -#> 1 5.1 3.5 1.4 0.2 setosa -#> 2 4.9 3.0 1.4 0.2 setosa -#> 3 4.7 3.2 1.3 0.2 setosa -#> 4 4.6 3.1 1.5 0.2 setosa -#> 5 5.0 3.6 1.4 0.2 setosa -#> -- -- -- -- -- -- -#> 146 6.7 3.0 5.2 2.3 virginica -#> 147 6.3 2.5 5.0 1.9 virginica -#> 148 6.5 3.0 5.2 2.0 virginica -#> 149 6.2 3.4 5.4 2.3 virginica -#> 150 5.9 3.0 5.1 1.8 virginica- class(ft)#> [1] "fst_table"#> $Sepal.Length -#> [1] "numeric" -#> -#> $Sepal.Width -#> [1] "numeric" -#> -#> $Petal.Length -#> [1] "numeric" -#> -#> $Petal.Width -#> [1] "numeric" -#> -#> $Species -#> [1] "factor" -#>names(ft)#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species"dim(ft)#> [1] 150 5summary_fst(ft)#> <fst file> -#> 150 rows, 5 columns (filea5434c14328.fst) -#> -#> * 'Sepal.Length': double -#> * 'Sepal.Width' : double -#> * 'Petal.Length': double -#> * 'Petal.Width' : double -#> * 'Species' : factor- # get the data by query - ft %>% slice_fst(1:3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 5.1 3.5 1.4 0.2 setosa -#> 2: 4.9 3.0 1.4 0.2 setosa -#> 3: 4.7 3.2 1.3 0.2 setosa#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 5.1 3.5 1.4 0.2 setosa -#> 2: 4.7 3.2 1.3 0.2 setosa- ft %>% select_fst(Sepal.Length)#> Sepal.Length -#> <num> -#> 1: 5.1 -#> 2: 4.9 -#> 3: 4.7 -#> 4: 4.6 -#> 5: 5.0 -#> --- -#> 146: 6.7 -#> 147: 6.3 -#> 148: 6.5 -#> 149: 6.2 -#> 150: 5.9ft %>% select_fst(Sepal.Length,Sepal.Width)#> Sepal.Length Sepal.Width -#> <num> <num> -#> 1: 5.1 3.5 -#> 2: 4.9 3.0 -#> 3: 4.7 3.2 -#> 4: 4.6 3.1 -#> 5: 5.0 3.6 -#> --- -#> 146: 6.7 3.0 -#> 147: 6.3 2.5 -#> 148: 6.5 3.0 -#> 149: 6.2 3.4 -#> 150: 5.9 3.0ft %>% select_fst("Sepal.Length")#> Sepal.Length -#> <num> -#> 1: 5.1 -#> 2: 4.9 -#> 3: 4.7 -#> 4: 4.6 -#> 5: 5.0 -#> --- -#> 146: 6.7 -#> 147: 6.3 -#> 148: 6.5 -#> 149: 6.2 -#> 150: 5.9ft %>% select_fst(1:3)#> Sepal.Length Sepal.Width Petal.Length -#> <num> <num> <num> -#> 1: 5.1 3.5 1.4 -#> 2: 4.9 3.0 1.4 -#> 3: 4.7 3.2 1.3 -#> 4: 4.6 3.1 1.5 -#> 5: 5.0 3.6 1.4 -#> --- -#> 146: 6.7 3.0 5.2 -#> 147: 6.3 2.5 5.0 -#> 148: 6.5 3.0 5.2 -#> 149: 6.2 3.4 5.4 -#> 150: 5.9 3.0 5.1ft %>% select_fst(1,3)#> Sepal.Length Petal.Length -#> <num> <num> -#> 1: 5.1 1.4 -#> 2: 4.9 1.4 -#> 3: 4.7 1.3 -#> 4: 4.6 1.5 -#> 5: 5.0 1.4 -#> --- -#> 146: 6.7 5.2 -#> 147: 6.3 5.0 -#> 148: 6.5 5.2 -#> 149: 6.2 5.4 -#> 150: 5.9 5.1ft %>% select_fst("Se")#> Sepal.Length Sepal.Width -#> <num> <num> -#> 1: 5.1 3.5 -#> 2: 4.9 3.0 -#> 3: 4.7 3.2 -#> 4: 4.6 3.1 -#> 5: 5.0 3.6 -#> --- -#> 146: 6.7 3.0 -#> 147: 6.3 2.5 -#> 148: 6.5 3.0 -#> 149: 6.2 3.4 -#> 150: 5.9 3.0- # return a warning with message - # \donttest{ - ft %>% select_fst("nothing")#> Warning: No matched columns,try other patterns. Names of the `fst_table` are listed.#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species"# } - - ft %>% select_fst("Se|Sp")#> Sepal.Length Sepal.Width Species -#> <num> <num> <fctr> -#> 1: 5.1 3.5 setosa -#> 2: 4.9 3.0 setosa -#> 3: 4.7 3.2 setosa -#> 4: 4.6 3.1 setosa -#> 5: 5.0 3.6 setosa -#> --- -#> 146: 6.7 3.0 virginica -#> 147: 6.3 2.5 virginica -#> 148: 6.5 3.0 virginica -#> 149: 6.2 3.4 virginica -#> 150: 5.9 3.0 virginica#> Sepal.Width Petal.Length -#> <num> <num> -#> 1: 3.5 1.4 -#> 2: 3.0 1.4 -#> 3: 3.2 1.3 -#> 4: 3.1 1.5 -#> 5: 3.6 1.4 -#> --- -#> 146: 3.0 5.2 -#> 147: 2.5 5.0 -#> 148: 3.0 5.2 -#> 149: 3.4 5.4 -#> 150: 3.0 5.1- ft %>% filter_fst(Sepal.Width > 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 5.1 3.5 1.4 0.2 setosa -#> 2: 4.7 3.2 1.3 0.2 setosa -#> 3: 4.6 3.1 1.5 0.2 setosa -#> 4: 5.0 3.6 1.4 0.2 setosa -#> 5: 5.4 3.9 1.7 0.4 setosa -#> 6: 4.6 3.4 1.4 0.3 setosa -#> 7: 5.0 3.4 1.5 0.2 setosa -#> 8: 4.9 3.1 1.5 0.1 setosa -#> 9: 5.4 3.7 1.5 0.2 setosa -#> 10: 4.8 3.4 1.6 0.2 setosa -#> 11: 5.8 4.0 1.2 0.2 setosa -#> 12: 5.7 4.4 1.5 0.4 setosa -#> 13: 5.4 3.9 1.3 0.4 setosa -#> 14: 5.1 3.5 1.4 0.3 setosa -#> 15: 5.7 3.8 1.7 0.3 setosa -#> 16: 5.1 3.8 1.5 0.3 setosa -#> 17: 5.4 3.4 1.7 0.2 setosa -#> 18: 5.1 3.7 1.5 0.4 setosa -#> 19: 4.6 3.6 1.0 0.2 setosa -#> 20: 5.1 3.3 1.7 0.5 setosa -#> 21: 4.8 3.4 1.9 0.2 setosa -#> 22: 5.0 3.4 1.6 0.4 setosa -#> 23: 5.2 3.5 1.5 0.2 setosa -#> 24: 5.2 3.4 1.4 0.2 setosa -#> 25: 4.7 3.2 1.6 0.2 setosa -#> 26: 4.8 3.1 1.6 0.2 setosa -#> 27: 5.4 3.4 1.5 0.4 setosa -#> 28: 5.2 4.1 1.5 0.1 setosa -#> 29: 5.5 4.2 1.4 0.2 setosa -#> 30: 4.9 3.1 1.5 0.2 setosa -#> 31: 5.0 3.2 1.2 0.2 setosa -#> 32: 5.5 3.5 1.3 0.2 setosa -#> 33: 4.9 3.6 1.4 0.1 setosa -#> 34: 5.1 3.4 1.5 0.2 setosa -#> 35: 5.0 3.5 1.3 0.3 setosa -#> 36: 4.4 3.2 1.3 0.2 setosa -#> 37: 5.0 3.5 1.6 0.6 setosa -#> 38: 5.1 3.8 1.9 0.4 setosa -#> 39: 5.1 3.8 1.6 0.2 setosa -#> 40: 4.6 3.2 1.4 0.2 setosa -#> 41: 5.3 3.7 1.5 0.2 setosa -#> 42: 5.0 3.3 1.4 0.2 setosa -#> 43: 7.0 3.2 4.7 1.4 versicolor -#> 44: 6.4 3.2 4.5 1.5 versicolor -#> 45: 6.9 3.1 4.9 1.5 versicolor -#> 46: 6.3 3.3 4.7 1.6 versicolor -#> 47: 6.7 3.1 4.4 1.4 versicolor -#> 48: 5.9 3.2 4.8 1.8 versicolor -#> 49: 6.0 3.4 4.5 1.6 versicolor -#> 50: 6.7 3.1 4.7 1.5 versicolor -#> 51: 6.3 3.3 6.0 2.5 virginica -#> 52: 7.2 3.6 6.1 2.5 virginica -#> 53: 6.5 3.2 5.1 2.0 virginica -#> 54: 6.4 3.2 5.3 2.3 virginica -#> 55: 7.7 3.8 6.7 2.2 virginica -#> 56: 6.9 3.2 5.7 2.3 virginica -#> 57: 6.7 3.3 5.7 2.1 virginica -#> 58: 7.2 3.2 6.0 1.8 virginica -#> 59: 7.9 3.8 6.4 2.0 virginica -#> 60: 6.3 3.4 5.6 2.4 virginica -#> 61: 6.4 3.1 5.5 1.8 virginica -#> 62: 6.9 3.1 5.4 2.1 virginica -#> 63: 6.7 3.1 5.6 2.4 virginica -#> 64: 6.9 3.1 5.1 2.3 virginica -#> 65: 6.8 3.2 5.9 2.3 virginica -#> 66: 6.7 3.3 5.7 2.5 virginica -#> 67: 6.2 3.4 5.4 2.3 virginica -#> Sepal.Length Sepal.Width Petal.Length Petal.Width Speciesft %>% filter_fst(Sepal.Length > 6 , Species == "virginica")#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 6.3 3.3 6.0 2.5 virginica -#> 2: 7.1 3.0 5.9 2.1 virginica -#> 3: 6.3 2.9 5.6 1.8 virginica -#> 4: 6.5 3.0 5.8 2.2 virginica -#> 5: 7.6 3.0 6.6 2.1 virginica -#> 6: 7.3 2.9 6.3 1.8 virginica -#> 7: 6.7 2.5 5.8 1.8 virginica -#> 8: 7.2 3.6 6.1 2.5 virginica -#> 9: 6.5 3.2 5.1 2.0 virginica -#> 10: 6.4 2.7 5.3 1.9 virginica -#> 11: 6.8 3.0 5.5 2.1 virginica -#> 12: 6.4 3.2 5.3 2.3 virginica -#> 13: 6.5 3.0 5.5 1.8 virginica -#> 14: 7.7 3.8 6.7 2.2 virginica -#> 15: 7.7 2.6 6.9 2.3 virginica -#> 16: 6.9 3.2 5.7 2.3 virginica -#> 17: 7.7 2.8 6.7 2.0 virginica -#> 18: 6.3 2.7 4.9 1.8 virginica -#> 19: 6.7 3.3 5.7 2.1 virginica -#> 20: 7.2 3.2 6.0 1.8 virginica -#> 21: 6.2 2.8 4.8 1.8 virginica -#> 22: 6.1 3.0 4.9 1.8 virginica -#> 23: 6.4 2.8 5.6 2.1 virginica -#> 24: 7.2 3.0 5.8 1.6 virginica -#> 25: 7.4 2.8 6.1 1.9 virginica -#> 26: 7.9 3.8 6.4 2.0 virginica -#> 27: 6.4 2.8 5.6 2.2 virginica -#> 28: 6.3 2.8 5.1 1.5 virginica -#> 29: 6.1 2.6 5.6 1.4 virginica -#> 30: 7.7 3.0 6.1 2.3 virginica -#> 31: 6.3 3.4 5.6 2.4 virginica -#> 32: 6.4 3.1 5.5 1.8 virginica -#> 33: 6.9 3.1 5.4 2.1 virginica -#> 34: 6.7 3.1 5.6 2.4 virginica -#> 35: 6.9 3.1 5.1 2.3 virginica -#> 36: 6.8 3.2 5.9 2.3 virginica -#> 37: 6.7 3.3 5.7 2.5 virginica -#> 38: 6.7 3.0 5.2 2.3 virginica -#> 39: 6.3 2.5 5.0 1.9 virginica -#> 40: 6.5 3.0 5.2 2.0 virginica -#> 41: 6.2 3.4 5.4 2.3 virginica -#> Sepal.Length Sepal.Width Petal.Length Petal.Width Speciesft %>% filter_fst(Sepal.Length > 6 & Species == "virginica" & Sepal.Width < 3)#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 6.3 2.9 5.6 1.8 virginica -#> 2: 7.3 2.9 6.3 1.8 virginica -#> 3: 6.7 2.5 5.8 1.8 virginica -#> 4: 6.4 2.7 5.3 1.9 virginica -#> 5: 7.7 2.6 6.9 2.3 virginica -#> 6: 7.7 2.8 6.7 2.0 virginica -#> 7: 6.3 2.7 4.9 1.8 virginica -#> 8: 6.2 2.8 4.8 1.8 virginica -#> 9: 6.4 2.8 5.6 2.1 virginica -#> 10: 7.4 2.8 6.1 1.9 virginica -#> 11: 6.4 2.8 5.6 2.2 virginica -#> 12: 6.3 2.8 5.1 1.5 virginica -#> 13: 6.1 2.6 5.6 1.4 virginica -#> 14: 6.3 2.5 5.0 1.9 virginica-++See also
+ ++Examples
+++ # write the file first + path = tempfile(fileext = ".fst") + fst::write_fst(iris,path) + # parse the file but not reading it + parse_fst(path) -> ft + + ft +#> <fst file> +#> 150 rows, 5 columns (file27604466d41.fst) +#> +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species +#> <double> <double> <double> <double> <factor> +#> 1 5.1 3.5 1.4 0.2 setosa +#> 2 4.9 3.0 1.4 0.2 setosa +#> 3 4.7 3.2 1.3 0.2 setosa +#> 4 4.6 3.1 1.5 0.2 setosa +#> 5 5.0 3.6 1.4 0.2 setosa +#> -- -- -- -- -- -- +#> 146 6.7 3.0 5.2 2.3 virginica +#> 147 6.3 2.5 5.0 1.9 virginica +#> 148 6.5 3.0 5.2 2.0 virginica +#> 149 6.2 3.4 5.4 2.3 virginica +#> 150 5.9 3.0 5.1 1.8 virginica + + class(ft) +#> [1] "fst_table" + lapply(ft,class) +#> $Sepal.Length +#> [1] "numeric" +#> +#> $Sepal.Width +#> [1] "numeric" +#> +#> $Petal.Length +#> [1] "numeric" +#> +#> $Petal.Width +#> [1] "numeric" +#> +#> $Species +#> [1] "factor" +#> + names(ft) +#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species" + dim(ft) +#> [1] 150 5 + summary_fst(ft) +#> <fst file> +#> 150 rows, 5 columns (file27604466d41.fst) +#> +#> * 'Sepal.Length': double +#> * 'Sepal.Width' : double +#> * 'Petal.Length': double +#> * 'Petal.Width' : double +#> * 'Species' : factor + + # get the data by query + ft %>% slice_fst(1:3) +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species +#> <num> <num> <num> <num> <fctr> +#> 1: 5.1 3.5 1.4 0.2 setosa +#> 2: 4.9 3.0 1.4 0.2 setosa +#> 3: 4.7 3.2 1.3 0.2 setosa + ft %>% slice_fst(c(1,3)) +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species +#> <num> <num> <num> <num> <fctr> +#> 1: 5.1 3.5 1.4 0.2 setosa +#> 2: 4.7 3.2 1.3 0.2 setosa + + ft %>% select_fst(Sepal.Length) +#> Sepal.Length +#> <num> +#> 1: 5.1 +#> 2: 4.9 +#> 3: 4.7 +#> 4: 4.6 +#> 5: 5.0 +#> --- +#> 146: 6.7 +#> 147: 6.3 +#> 148: 6.5 +#> 149: 6.2 +#> 150: 5.9 + ft %>% select_fst(Sepal.Length,Sepal.Width) +#> Sepal.Length Sepal.Width +#> <num> <num> +#> 1: 5.1 3.5 +#> 2: 4.9 3.0 +#> 3: 4.7 3.2 +#> 4: 4.6 3.1 +#> 5: 5.0 3.6 +#> --- +#> 146: 6.7 3.0 +#> 147: 6.3 2.5 +#> 148: 6.5 3.0 +#> 149: 6.2 3.4 +#> 150: 5.9 3.0 + ft %>% select_fst("Sepal.Length") +#> Sepal.Length +#> <num> +#> 1: 5.1 +#> 2: 4.9 +#> 3: 4.7 +#> 4: 4.6 +#> 5: 5.0 +#> --- +#> 146: 6.7 +#> 147: 6.3 +#> 148: 6.5 +#> 149: 6.2 +#> 150: 5.9 + ft %>% select_fst(1:3) +#> Sepal.Length Sepal.Width Petal.Length +#> <num> <num> <num> +#> 1: 5.1 3.5 1.4 +#> 2: 4.9 3.0 1.4 +#> 3: 4.7 3.2 1.3 +#> 4: 4.6 3.1 1.5 +#> 5: 5.0 3.6 1.4 +#> --- +#> 146: 6.7 3.0 5.2 +#> 147: 6.3 2.5 5.0 +#> 148: 6.5 3.0 5.2 +#> 149: 6.2 3.4 5.4 +#> 150: 5.9 3.0 5.1 + ft %>% select_fst(1,3) +#> Sepal.Length Petal.Length +#> <num> <num> +#> 1: 5.1 1.4 +#> 2: 4.9 1.4 +#> 3: 4.7 1.3 +#> 4: 4.6 1.5 +#> 5: 5.0 1.4 +#> --- +#> 146: 6.7 5.2 +#> 147: 6.3 5.0 +#> 148: 6.5 5.2 +#> 149: 6.2 5.4 +#> 150: 5.9 5.1 + ft %>% select_fst("Se") +#> Sepal.Length Sepal.Width +#> <num> <num> +#> 1: 5.1 3.5 +#> 2: 4.9 3.0 +#> 3: 4.7 3.2 +#> 4: 4.6 3.1 +#> 5: 5.0 3.6 +#> --- +#> 146: 6.7 3.0 +#> 147: 6.3 2.5 +#> 148: 6.5 3.0 +#> 149: 6.2 3.4 +#> 150: 5.9 3.0 + + # return a warning with message + # \donttest{ + ft %>% select_fst("nothing") +#> Warning: No matched columns,try other patterns. Names of the `fst_table` are listed. +#> [1] "Sepal.Length" "Sepal.Width" "Petal.Length" "Petal.Width" "Species" + # } + + ft %>% select_fst("Se|Sp") +#> Sepal.Length Sepal.Width Species +#> <num> <num> <fctr> +#> 1: 5.1 3.5 setosa +#> 2: 4.9 3.0 setosa +#> 3: 4.7 3.2 setosa +#> 4: 4.6 3.1 setosa +#> 5: 5.0 3.6 setosa +#> --- +#> 146: 6.7 3.0 virginica +#> 147: 6.3 2.5 virginica +#> 148: 6.5 3.0 virginica +#> 149: 6.2 3.4 virginica +#> 150: 5.9 3.0 virginica + ft %>% select_fst(cols = names(iris)[2:3]) +#> Sepal.Width Petal.Length +#> <num> <num> +#> 1: 3.5 1.4 +#> 2: 3.0 1.4 +#> 3: 3.2 1.3 +#> 4: 3.1 1.5 +#> 5: 3.6 1.4 +#> --- +#> 146: 3.0 5.2 +#> 147: 2.5 5.0 +#> 148: 3.0 5.2 +#> 149: 3.4 5.4 +#> 150: 3.0 5.1 + + ft %>% filter_fst(Sepal.Width > 3) +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species +#> <num> <num> <num> <num> <fctr> +#> 1: 5.1 3.5 1.4 0.2 setosa +#> 2: 4.7 3.2 1.3 0.2 setosa +#> 3: 4.6 3.1 1.5 0.2 setosa +#> 4: 5.0 3.6 1.4 0.2 setosa +#> 5: 5.4 3.9 1.7 0.4 setosa +#> 6: 4.6 3.4 1.4 0.3 setosa +#> 7: 5.0 3.4 1.5 0.2 setosa +#> 8: 4.9 3.1 1.5 0.1 setosa +#> 9: 5.4 3.7 1.5 0.2 setosa +#> 10: 4.8 3.4 1.6 0.2 setosa +#> 11: 5.8 4.0 1.2 0.2 setosa +#> 12: 5.7 4.4 1.5 0.4 setosa +#> 13: 5.4 3.9 1.3 0.4 setosa +#> 14: 5.1 3.5 1.4 0.3 setosa +#> 15: 5.7 3.8 1.7 0.3 setosa +#> 16: 5.1 3.8 1.5 0.3 setosa +#> 17: 5.4 3.4 1.7 0.2 setosa +#> 18: 5.1 3.7 1.5 0.4 setosa +#> 19: 4.6 3.6 1.0 0.2 setosa +#> 20: 5.1 3.3 1.7 0.5 setosa +#> 21: 4.8 3.4 1.9 0.2 setosa +#> 22: 5.0 3.4 1.6 0.4 setosa +#> 23: 5.2 3.5 1.5 0.2 setosa +#> 24: 5.2 3.4 1.4 0.2 setosa +#> 25: 4.7 3.2 1.6 0.2 setosa +#> 26: 4.8 3.1 1.6 0.2 setosa +#> 27: 5.4 3.4 1.5 0.4 setosa +#> 28: 5.2 4.1 1.5 0.1 setosa +#> 29: 5.5 4.2 1.4 0.2 setosa +#> 30: 4.9 3.1 1.5 0.2 setosa +#> 31: 5.0 3.2 1.2 0.2 setosa +#> 32: 5.5 3.5 1.3 0.2 setosa +#> 33: 4.9 3.6 1.4 0.1 setosa +#> 34: 5.1 3.4 1.5 0.2 setosa +#> 35: 5.0 3.5 1.3 0.3 setosa +#> 36: 4.4 3.2 1.3 0.2 setosa +#> 37: 5.0 3.5 1.6 0.6 setosa +#> 38: 5.1 3.8 1.9 0.4 setosa +#> 39: 5.1 3.8 1.6 0.2 setosa +#> 40: 4.6 3.2 1.4 0.2 setosa +#> 41: 5.3 3.7 1.5 0.2 setosa +#> 42: 5.0 3.3 1.4 0.2 setosa +#> 43: 7.0 3.2 4.7 1.4 versicolor +#> 44: 6.4 3.2 4.5 1.5 versicolor +#> 45: 6.9 3.1 4.9 1.5 versicolor +#> 46: 6.3 3.3 4.7 1.6 versicolor +#> 47: 6.7 3.1 4.4 1.4 versicolor +#> 48: 5.9 3.2 4.8 1.8 versicolor +#> 49: 6.0 3.4 4.5 1.6 versicolor +#> 50: 6.7 3.1 4.7 1.5 versicolor +#> 51: 6.3 3.3 6.0 2.5 virginica +#> 52: 7.2 3.6 6.1 2.5 virginica +#> 53: 6.5 3.2 5.1 2.0 virginica +#> 54: 6.4 3.2 5.3 2.3 virginica +#> 55: 7.7 3.8 6.7 2.2 virginica +#> 56: 6.9 3.2 5.7 2.3 virginica +#> 57: 6.7 3.3 5.7 2.1 virginica +#> 58: 7.2 3.2 6.0 1.8 virginica +#> 59: 7.9 3.8 6.4 2.0 virginica +#> 60: 6.3 3.4 5.6 2.4 virginica +#> 61: 6.4 3.1 5.5 1.8 virginica +#> 62: 6.9 3.1 5.4 2.1 virginica +#> 63: 6.7 3.1 5.6 2.4 virginica +#> 64: 6.9 3.1 5.1 2.3 virginica +#> 65: 6.8 3.2 5.9 2.3 virginica +#> 66: 6.7 3.3 5.7 2.5 virginica +#> 67: 6.2 3.4 5.4 2.3 virginica +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species + ft %>% filter_fst(Sepal.Length > 6 , Species == "virginica") +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species +#> <num> <num> <num> <num> <fctr> +#> 1: 6.3 3.3 6.0 2.5 virginica +#> 2: 7.1 3.0 5.9 2.1 virginica +#> 3: 6.3 2.9 5.6 1.8 virginica +#> 4: 6.5 3.0 5.8 2.2 virginica +#> 5: 7.6 3.0 6.6 2.1 virginica +#> 6: 7.3 2.9 6.3 1.8 virginica +#> 7: 6.7 2.5 5.8 1.8 virginica +#> 8: 7.2 3.6 6.1 2.5 virginica +#> 9: 6.5 3.2 5.1 2.0 virginica +#> 10: 6.4 2.7 5.3 1.9 virginica +#> 11: 6.8 3.0 5.5 2.1 virginica +#> 12: 6.4 3.2 5.3 2.3 virginica +#> 13: 6.5 3.0 5.5 1.8 virginica +#> 14: 7.7 3.8 6.7 2.2 virginica +#> 15: 7.7 2.6 6.9 2.3 virginica +#> 16: 6.9 3.2 5.7 2.3 virginica +#> 17: 7.7 2.8 6.7 2.0 virginica +#> 18: 6.3 2.7 4.9 1.8 virginica +#> 19: 6.7 3.3 5.7 2.1 virginica +#> 20: 7.2 3.2 6.0 1.8 virginica +#> 21: 6.2 2.8 4.8 1.8 virginica +#> 22: 6.1 3.0 4.9 1.8 virginica +#> 23: 6.4 2.8 5.6 2.1 virginica +#> 24: 7.2 3.0 5.8 1.6 virginica +#> 25: 7.4 2.8 6.1 1.9 virginica +#> 26: 7.9 3.8 6.4 2.0 virginica +#> 27: 6.4 2.8 5.6 2.2 virginica +#> 28: 6.3 2.8 5.1 1.5 virginica +#> 29: 6.1 2.6 5.6 1.4 virginica +#> 30: 7.7 3.0 6.1 2.3 virginica +#> 31: 6.3 3.4 5.6 2.4 virginica +#> 32: 6.4 3.1 5.5 1.8 virginica +#> 33: 6.9 3.1 5.4 2.1 virginica +#> 34: 6.7 3.1 5.6 2.4 virginica +#> 35: 6.9 3.1 5.1 2.3 virginica +#> 36: 6.8 3.2 5.9 2.3 virginica +#> 37: 6.7 3.3 5.7 2.5 virginica +#> 38: 6.7 3.0 5.2 2.3 virginica +#> 39: 6.3 2.5 5.0 1.9 virginica +#> 40: 6.5 3.0 5.2 2.0 virginica +#> 41: 6.2 3.4 5.4 2.3 virginica +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species + ft %>% filter_fst(Sepal.Length > 6 & Species == "virginica" & Sepal.Width < 3) +#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species +#> <num> <num> <num> <num> <fctr> +#> 1: 6.3 2.9 5.6 1.8 virginica +#> 2: 7.3 2.9 6.3 1.8 virginica +#> 3: 6.7 2.5 5.8 1.8 virginica +#> 4: 6.4 2.7 5.3 1.9 virginica +#> 5: 7.7 2.6 6.9 2.3 virginica +#> 6: 7.7 2.8 6.7 2.0 virginica +#> 7: 6.3 2.7 4.9 1.8 virginica +#> 8: 6.2 2.8 4.8 1.8 virginica +#> 9: 6.4 2.8 5.6 2.1 virginica +#> 10: 7.4 2.8 6.1 1.9 virginica +#> 11: 6.4 2.8 5.6 2.2 virginica +#> 12: 6.3 2.8 5.1 1.5 virginica +#> 13: 6.1 2.6 5.6 1.4 virginica +#> 14: 6.3 2.5 5.0 1.9 virginica + +
-
-
-
-
-
+
+
-
-
-
+
+
old_format
+
-
-
- Wrapper for read_fst and write_fst
+
Wrapper for read_fst and write_fst
from fst, but use a different default. For data import, always return a data.table.
For data export, always compress the data to the smallest size.
export_fst(x, path, compress = 100, uniform_encoding = TRUE) - -import_fst( - path, - columns = NULL, - from = 1, - to = NULL, - as.data.table = TRUE, - old_format = FALSE -)- -
Arguments
-data.table package to be installed.
+
- Value
+must be FALSE, the old fst file format is deprecated and can only be read and +converted with fst package versions 0.8.0 to 0.8.10.
+
-
+ Value
`import_fst` returns a data.table with the selected columns and rows. `export_fst` writes `x` to a `fst` file and invisibly returns `x` (so you can use this function in a pipeline).
-See also
- - - -Examples
---# \donttest{ -export_fst(iris,"iris_fst_test.fst") -iris_dt = import_fst("iris_fst_test.fst") -iris_dt#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species -#> <num> <num> <num> <num> <fctr> -#> 1: 5.1 3.5 1.4 0.2 setosa -#> 2: 4.9 3.0 1.4 0.2 setosa -#> 3: 4.7 3.2 1.3 0.2 setosa -#> 4: 4.6 3.1 1.5 0.2 setosa -#> 5: 5.0 3.6 1.4 0.2 setosa -#> --- -#> 146: 6.7 3.0 5.2 2.3 virginica -#> 147: 6.3 2.5 5.0 1.9 virginica -#> 148: 6.5 3.0 5.2 2.0 virginica -#> 149: 6.2 3.4 5.4 2.3 virginica -#> 150: 5.9 3.0 5.1 1.8 virginica
+
+ See also
+ +
+
+
Examples
+
+# \donttest{
+export_fst(iris,"iris_fst_test.fst")
+iris_dt = import_fst("iris_fst_test.fst")
+iris_dt
+#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
+#> <num> <num> <num> <num> <fctr>
+#> 1: 5.1 3.5 1.4 0.2 setosa
+#> 2: 4.9 3.0 1.4 0.2 setosa
+#> 3: 4.7 3.2 1.3 0.2 setosa
+#> 4: 4.6 3.1 1.5 0.2 setosa
+#> 5: 5.0 3.6 1.4 0.2 setosa
+#> ---
+#> 146: 6.7 3.0 5.2 2.3 virginica
+#> 147: 6.3 2.5 5.0 1.9 virginica
+#> 148: 6.5 3.0 5.2 2.0 virginica
+#> 149: 6.2 3.4 5.4 2.3 virginica
+#> 150: 5.9 3.0 5.1 1.8 virginica
+unlink("iris_fst_test.fst")
+# }
+
+