https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/ Recent content in Code Testing on Handbook Hugo -- gohugo.io https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/code-testing-protocol/ Mon, 01 Jan 0001 00:00:00 +0000 https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/code-testing-protocol/ What makes code close to perfect? We test our code to assure it is safe What do we use to test our code? What do we use to verify whether code is properly documented? When is our code tested sufficiently? Overall recommendations What makes code close to perfect? Any code that we write should fulfill four requirements: It should be safe. It should be efficient. https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/testing-strategies/ Mon, 01 Jan 0001 00:00:00 +0000 https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/testing-strategies/ Why write automated tests? Code testing strategies Example of tests Test inputs and outputs Errors and warnings Testing structure Why write automated tests? Testing code can be performed in two different ways: manual and automated. The first approach means that every time we write a new function, or refactor code, or add some new arguments to a function call, we would need to figure out what behaviour we expect. https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/testing-inside-function/ Mon, 01 Jan 0001 00:00:00 +0000 https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/testing-inside-function/ Why test inside a function? It’s important to have tests that will serve as a sanity check inside our functions. These tests are usually made to throw an error if something is wrong with the entered parameters, which are passed to a function call. For instance, it can be valuable to check if an parameter is of character type or if all the necessary columns are present in a data.frame. https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/using-mockups/ Mon, 01 Jan 0001 00:00:00 +0000 https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/using-mockups/ Why use mockups? Data as an argument Data needs to be downloaded or processed within function Why use mockups? In some cases we might be unable to test functionalities. This might be due to long time of computation, or the function needs inputs that are stored on an external server. This also includes functions that deal with data that change in time (for instance data provided by an external API). https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/testing-best-practices/ Mon, 01 Jan 0001 00:00:00 +0000 https://handbook.gradientmetrics.com/product-team/coding/package-development/code-testing/testing-best-practices/ Testing is crucial for developing robust and safe code. Nonetheless, writing automated test is difficult and a time consuming process. Here is short summary of things you may want to consider before you start writing tests. Keep functions as small as possible. Functions should deal with one single thing, and they should deal with it good. For instance consider separating data wrangling from plotting or modeling. Make some sanity checks within function (e.