{"id":29927807,"url":"https://github.com/antoniof1704/funcmapper","last_synced_at":"2025-08-02T13:49:00.913Z","repository":{"id":304521274,"uuid":"1016979297","full_name":"antoniof1704/funcMapper","owner":"antoniof1704","description":"R package designed to visualise all user-defined functions in a given R script, along with any other user-defined functions they depend on. This tool helps users understand how functions are interconnected within a codebase.","archived":false,"fork":false,"pushed_at":"2025-07-30T15:43:33.000Z","size":134,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-30T17:39:36.135Z","etag":null,"topics":["dependencies-graph","funcmapper","mapping","package","r","user-functions"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/antoniof1704.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","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,"zenodo":null}},"created_at":"2025-07-09T20:42:11.000Z","updated_at":"2025-07-30T15:43:37.000Z","dependencies_parsed_at":"2025-07-13T17:36:17.533Z","dependency_job_id":"c5c88e87-4dc1-43d0-a8f4-5ab9d4531692","html_url":"https://github.com/antoniof1704/funcMapper","commit_stats":null,"previous_names":["antoniof1704/funcmapper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/antoniof1704/funcMapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniof1704%2FfuncMapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniof1704%2FfuncMapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniof1704%2FfuncMapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniof1704%2FfuncMapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antoniof1704","download_url":"https://codeload.github.com/antoniof1704/funcMapper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniof1704%2FfuncMapper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268400781,"owners_count":24244450,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["dependencies-graph","funcmapper","mapping","package","r","user-functions"],"created_at":"2025-08-02T13:48:55.597Z","updated_at":"2025-08-02T13:49:00.861Z","avatar_url":"https://github.com/antoniof1704.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# funcMapper\n\n[![CRAN version](https://www.r-pkg.org/badges/version/funcMapper)](https://CRAN.R-project.org/package=funcMapper)\n[![R-CMD-check](https://github.com/antoniof1704/funcMapper/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/antoniof1704/funcMapper/actions/workflows/R-CMD-check.yaml)\n[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/grand-total/funcMapper)](https://cran.r-project.org/package=funcMapper)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\n## Overview\nfuncMapper is an R package designed to visualise all user-defined functions in a given R script, along with any other user-defined functions they depend on. This tool helps users understand how functions are interconnected within a codebase.\n\nIt is especially useful for:\n - Developers new to a codebase who want to quickly understand how functions are used.\n - Teams working collaboratively, to track how newly added functions are being utilised.\n - Developers handing over a project, to provide a clear overview of function dependencies.\n\n## Installation\n\nInstall the latest version of funcMapper from CRAN with:\n\n``` r\ninstall.packages(\"funcMapper\")\n```\n\n## How to Use funcMapper \n\n**funcMapper(script_path, output_name, output_path, source = FALSE, cleanup_temp_file = TRUE)**\n\nArguments:\n\n*script_path*: File path of the R script to analyse (must end with.R).\n\n*output_name*: Name of the output HTML file (no need to include .html).\n\n*output_path*: Directory where the HTML file will be saved (do not include a trailing /).\n\n*source*: Whether to run the script to load functions into the global environment (default is FALSE; set to TRUE if needed). If set to TRUE, the function will fail if the underlying script encounters any errors during execution.\n\n*cleanup_temp_file*: Whether to delete the temporary script file used during mapping (default is TRUE; set to FALSE to retain it).\n\nThe function generates an interactive HTML file containing the function map, saved to the specified output_path.\n\n## Example Output\n\nBelow is an example of the output generated by funcMapper. The map is saved as an HTML file and can be viewed in any browser.\n\n\u003cp align=\"left\"\u003e\n\u003cimg src=\"vignettes/example_funcMapper.png\" align=\"left\" height=\"400\"/\u003e\n\nIn this example, the script ‘main_script.R’ is used as the entry point and is highlighted in red. The map shows how user-defined functions are interconnected. For instance, the function *funcG* is called by both *funcC* and *funcD*.\n\nNote: You can run funcMapper on any script, not just the main script of a project. However, the script will be wrapped in a function during processing. If the script is already a function, it will be wrapped again.\n\n## More Information \n\n* funcMapper is available on [CRAN](https://cran.r-project.org/web/packages/funcMapper/index.html)\n\n* An introduction to funcMapper is available in the [vignette](https://cran.r-project.org/web/packages/funcMapper/vignettes/funcMapper-guidance.html)\n\n* Please report bugs or other issues [here](https://github.com/antoniof1704/funcMapper/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoniof1704%2Ffuncmapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantoniof1704%2Ffuncmapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoniof1704%2Ffuncmapper/lists"}