{"id":16718689,"url":"https://github.com/planeshifter/fisher-transform","last_synced_at":"2025-04-10T08:53:38.362Z","repository":{"id":26637985,"uuid":"30093850","full_name":"Planeshifter/fisher-transform","owner":"Planeshifter","description":"inference for correlation rho via fisher transformation","archived":false,"fork":false,"pushed_at":"2023-08-23T02:07:57.000Z","size":14,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-24T18:23:55.312Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Planeshifter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-01-30T22:36:14.000Z","updated_at":"2023-08-23T02:05:33.000Z","dependencies_parsed_at":"2024-10-12T21:48:17.521Z","dependency_job_id":null,"html_url":"https://github.com/Planeshifter/fisher-transform","commit_stats":{"total_commits":21,"total_committers":1,"mean_commits":21.0,"dds":0.0,"last_synced_commit":"d66ce8712c5c998cfdb9832a426f61e5df3331a8"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Ffisher-transform","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Ffisher-transform/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Ffisher-transform/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Ffisher-transform/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Planeshifter","download_url":"https://codeload.github.com/Planeshifter/fisher-transform/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248190407,"owners_count":21062277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T21:38:07.866Z","updated_at":"2025-04-10T08:53:38.335Z","avatar_url":"https://github.com/Planeshifter.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM version][npm-image]][npm-url]\n[![Coverage Status][coveralls-image]][coveralls-url]\n\n# Inference for Pearson correlation\n\n## Installation \u0026 Usage\n\n```\nnpm install fisher-transform\n```\n\nRequire as follows:\n\n```\nvar fisher = require('fisher-transform');\n```\n\n`fisher` exports the following functions:\n\n## `fisherTest(rho, n, [alpha, alternative, rho_0]`)\n\nThe function parameters are:\n- rho: the Pearson correlation for which inference should be carried out\n- n: the number of sample observations\n- alpha: the significance level of the test, default value is 0.05\n- alternative: default value \"two-sided\", for one-sided tests options \"greater\" and \"less\" exist\n- rho_0: the value of rho assumed under the null hypothesis, default value is 0\n\nSpecifically, the two-sided test is\n\nH_0: rho = rho_0 vs. H_1: rho != rho_0\n\nand the one-sided tests are\n\nH_0: rho = rho_0 vs. H_1: rho \u003e= rho_0\n\nand\n\nH_0: rho = rho_0 vs. H_1: rho \u003c= rho_0\n\nFor the chosen test, its p-value is calculated. In addition, a 1-alpha confidence interval is constructed by inverting the test statistic. The function returns an object with with two keys: pvalue and CI. The former holds the pvalue, while the latter is an Array with two elements, the lower and upper bounds of the calculated confidence interval.\n\n## `r2z(r)`\n\nApplies the Fisher transformation to r to obtain z, where z = arctanh(r)\n\n## `z2r(z)`\nApplies the inverse Fisher transformation to z in order to recover r, where r = tanh(z)\n\n## `zScore(r, r_0, n)`\nReturns the Fisher z-score for Pearson correlation r under the null hypothesis that r = r_0. Approximately, the z-score follows a standard normal distribution.\n\n## Unit Tests\n\nRun tests via the command `npm test`\n\n---\n## License\n\n[MIT license](http://opensource.org/licenses/MIT).\n\n[npm-image]: https://badge.fury.io/js/fisher-transform.svg\n[npm-url]: http://badge.fury.io/js/fisher-transform\n\n[coveralls-image]: https://img.shields.io/coveralls/Planeshifter/fisher-transform/master.svg\n[coveralls-url]: https://coveralls.io/r/Planeshifter/fisher-transform?branch=master\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaneshifter%2Ffisher-transform","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplaneshifter%2Ffisher-transform","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaneshifter%2Ffisher-transform/lists"}