Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/octri/redcap-report-counts
A REDCap external module for generating consort reports.
https://github.com/octri/redcap-report-counts
redcap redcap-external-module report-counts
Last synced: about 2 months ago
JSON representation
A REDCap external module for generating consort reports.
- Host: GitHub
- URL: https://github.com/octri/redcap-report-counts
- Owner: OCTRI
- License: bsd-2-clause
- Created: 2018-08-31T20:52:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T23:24:42.000Z (3 months ago)
- Last Synced: 2024-09-14T13:44:57.372Z (3 months ago)
- Topics: redcap, redcap-external-module, report-counts
- Language: JavaScript
- Size: 2.86 MB
- Stars: 3
- Watchers: 6
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# REDCap Report Counts External Module
A REDCap external module for generating report counts.
## Install Dependencies
```
npm install
```
## Run Unit Tests
JavaScript tests,
```
npm test
```
PHP tests
```
composer test
```
## Build Application
Compilation is output into the `dist` directory.
```
npm run build
```
## Start Application for Local Development
To continuously build the application as you develop, run,
```
npm run start
```
## Install the module
### Module directory format
External modules live in the `modules` directory under the REDCap root directory. After building the project copy the `dist` directory there and rename it as follows,
```
redcap/modules/report_counts_vx.y.z
```
where `report_counts` is the module prefix, and `x.y.z` is the version.
#### Running under Docker
If you are running REDCap under Docker, you may want to bind mount the `dist` directory. For example,
```
volumes:
- /path/to/report-counts/dist:/var/www/html/redcap/modules/report_counts_v0.0.0
```
Now changes are published instantly when running `npm run start`.
### Module URLs
In code, you may generate a page URL using the following syntax where `$module` is provided automatically. This will produce the index URL above.
```
$indexUrl = $module->getUrl('index');
```
The URL will look something like the following,
http://localhost/redcap/external_modules/?prefix=report_counts&id=5&page=index&pid=782
with these parameters: `prefix`, `id`, `page`, and `pid`.
`prefix` is the module prefix as described previously.
`id` is the module id and is appended automatically when using the module functions, such as `getUrl()`.
`page` corresponds to the PHP file. For example, `page=index` will pull up `index.php`. Including the `.php` extension is optional.
`pid` is the project id.
### Enabling the module
Once your module directory is in place we need to tell REDCap about it.
1. Navigate to *Control Center > External Modules*.
2. Click *Enable a module*.
3. You should see report counts with a version drop-down. Select the version you want to enable and click *Enable*.
4. Next go to your project and on the left navigation bar click *External Modules*.
5. Click *Enable a module* and find the report counts module.
6. Click *Enable* to enable for your project.
Now you should see a link under the "External Modules" section on the left navigation bar.