From 0829bcb0e08e1940cad9c1b702806cdcbe703cd5 Mon Sep 17 00:00:00 2001 From: AG Damsbo Date: Wed, 8 Mar 2023 20:18:39 +0100 Subject: [PATCH] license --- .Rbuildignore | 1 + DESCRIPTION | 2 +- LICENSE.md | 595 +++++++++++++++++++++++++++++++++++++++++++++++ docs/pkgdown.yml | 2 +- docs/search.json | 2 +- docs/sitemap.xml | 3 + 6 files changed, 602 insertions(+), 3 deletions(-) create mode 100644 LICENSE.md diff --git a/.Rbuildignore b/.Rbuildignore index 7e9904f..fe05462 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ ^codecov\.yml$ ^_pkgdown\.yml$ ^pkgdown$ +^LICENSE\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index fdf95a8..f4e9fbc 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -28,7 +28,7 @@ Suggests: Hmisc, readr, covr -License: GPL-3 +License: GPL (>= 3) Encoding: UTF-8 LazyData: true RoxygenNote: 7.2.3 diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..175443c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,595 @@ +GNU General Public License +========================== + +_Version 3, 29 June 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for software and other +kinds of works. + +The licenses for most software and other practical works are designed to take away +your freedom to share and change the works. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change all versions of a +program--to make sure it remains free software for all its users. We, the Free +Software Foundation, use the GNU General Public License for most of our software; it +applies also to any other work released this way by its authors. You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General +Public Licenses are designed to make sure that you have the freedom to distribute +copies of free software (and charge for them if you wish), that you receive source +code or can get it if you want it, that you can change the software or use pieces of +it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or +asking you to surrender the rights. Therefore, you have certain responsibilities if +you distribute copies of the software, or if you modify it: responsibilities to +respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, +you must pass on to the recipients the same freedoms that you received. You must make +sure that they, too, receive or can get the source code. And you must show them these +terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: **(1)** assert +copyright on the software, and **(2)** offer you this License giving you legal permission +to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is +no warranty for this free software. For both users' and authors' sake, the GPL +requires that modified versions be marked as changed, so that their problems will not +be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of +the software inside them, although the manufacturer can do so. This is fundamentally +incompatible with the aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we have designed +this version of the GPL to prohibit the practice for those products. If such problems +arise substantially in other domains, we stand ready to extend this provision to +those domains in future versions of the GPL, as needed to protect the freedom of +users. + +Finally, every program is threatened constantly by software patents. States should +not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that patents +applied to a free program could make it effectively proprietary. To prevent this, the +GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact copy. The +resulting work is called a “modified version” of the earlier work or a +work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on +the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for infringement under +applicable copyright law, except executing it on a computer or modifying a private +copy. Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the +extent that it includes a convenient and prominently visible feature that **(1)** +displays an appropriate copyright notice, and **(2)** tells the user that there is no +warranty for the work (except to the extent that warranties are provided), that +licensees may convey the work under this License, and how to view a copy of this +License. If the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form of a +work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of interfaces +specified for a particular programming language, one that is widely used among +developers working in that language. + +The “System Libraries” of an executable work include anything, other than +the work as a whole, that **(a)** is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and **(b)** serves only to +enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code form. +A “Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on which +the executable work runs, or a compiler used to produce the work, or an object code +interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the +source code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. However, +it does not include the work's System Libraries, or general-purpose tools or +generally available free programs which are used unmodified in performing those +activities but which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for the work, and +the source code for shared libraries and dynamically linked subprograms that the work +is specifically designed to require, such as by intimate data communication or +control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of copyright on the +Program, and are irrevocable provided the stated conditions are met. This License +explicitly affirms your unlimited permission to run the unmodified Program. The +output from running a covered work is covered by this License only if the output, +given its content, constitutes a covered work. This License acknowledges your rights +of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey covered +works to others for the sole purpose of having them make modifications exclusively +for you, or provide you with facilities for running those works, provided that you +comply with the terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for you must do so +exclusively on your behalf, under your direction and control, on terms that prohibit +them from making any copies of your copyrighted material outside their relationship +with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological measure under any +applicable law fulfilling obligations under article 11 of the WIPO copyright treaty +adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention +of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of +technological measures to the extent such circumvention is effected by exercising +rights under this License with respect to the covered work, and you disclaim any +intention to limit operation or modification of the work as a means of enforcing, +against the work's users, your or third parties' legal rights to forbid circumvention +of technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you receive it, in any +medium, provided that you conspicuously and appropriately publish on each copy an +appropriate copyright notice; keep intact all notices stating that this License and +any non-permissive terms added in accord with section 7 apply to the code; keep +intact all notices of the absence of any warranty; and give all recipients a copy of +this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer +support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to produce it from +the Program, in the form of source code under the terms of section 4, provided that +you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified it, and giving a +relevant date. +* **b)** The work must carry prominent notices stating that it is released under this +License and any conditions added under section 7. This requirement modifies the +requirement in section 4 to “keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this License to anyone who +comes into possession of a copy. This License will therefore apply, along with any +applicable section 7 additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no permission to license the +work in any other way, but it does not invalidate such permission if you have +separately received it. +* **d)** If the work has interactive user interfaces, each must display Appropriate Legal +Notices; however, if the Program has interactive interfaces that do not display +Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are +not by their nature extensions of the covered work, and which are not combined with +it such as to form a larger program, in or on a volume of a storage or distribution +medium, is called an “aggregate” if the compilation and its resulting +copyright are not used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work in an aggregate +does not cause this License to apply to the other parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms of sections 4 and +5, provided that you also convey the machine-readable Corresponding Source under the +terms of this License, in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by the Corresponding Source fixed on a +durable physical medium customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by a written offer, valid for at least +three years and valid for as long as you offer spare parts or customer support for +that product model, to give anyone who possesses the object code either **(1)** a copy of +the Corresponding Source for all the software in the product that is covered by this +License, on a durable physical medium customarily used for software interchange, for +a price no more than your reasonable cost of physically performing this conveying of +source, or **(2)** access to copy the Corresponding Source from a network server at no +charge. +* **c)** Convey individual copies of the object code with a copy of the written offer to +provide the Corresponding Source. This alternative is allowed only occasionally and +noncommercially, and only if you received the object code with such an offer, in +accord with subsection 6b. +* **d)** Convey the object code by offering access from a designated place (gratis or for +a charge), and offer equivalent access to the Corresponding Source in the same way +through the same place at no further charge. You need not require recipients to copy +the Corresponding Source along with the object code. If the place to copy the object +code is a network server, the Corresponding Source may be on a different server +(operated by you or a third party) that supports equivalent copying facilities, +provided you maintain clear directions next to the object code saying where to find +the Corresponding Source. Regardless of what server hosts the Corresponding Source, +you remain obligated to ensure that it is available for as long as needed to satisfy +these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are being +offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. + +A “User Product” is either **(1)** a “consumer product”, which +means any tangible personal property which is normally used for personal, family, or +household purposes, or **(2)** anything designed or sold for incorporation into a +dwelling. In determining whether a product is a consumer product, doubtful cases +shall be resolved in favor of coverage. For a particular product received by a +particular user, “normally used” refers to a typical or common use of +that class of product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected to use, the +product. A product is a consumer product regardless of whether the product has +substantial commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the continued +functioning of the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for +use in, a User Product, and the conveying occurs as part of a transaction in which +the right of possession and use of the User Product is transferred to the recipient +in perpetuity or for a fixed term (regardless of how the transaction is +characterized), the Corresponding Source conveyed under this section must be +accompanied by the Installation Information. But this requirement does not apply if +neither you nor any third party retains the ability to install modified object code +on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to +continue to provide support service, warranty, or updates for a work that has been +modified or installed by the recipient, or for the User Product in which it has been +modified or installed. Access to a network may be denied when the modification itself +materially and adversely affects the operation of the network or violates the rules +and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with +this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require no +special password or key for unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. Additional +permissions that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may be +used separately under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when you +modify the work.) You may place additional permissions on material, added by you to a +covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed by works +containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or requiring that +modified versions of such material be marked in reasonable ways as different from the +original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or authors of the +material; or +* **e)** Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that material by anyone +who conveys the material (or modified versions of it) with contractual assumptions of +liability to the recipient, for any liability that these contractual assumptions +directly impose on those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you received +it, or any part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. If a +license document contains a further restriction but permits relicensing or conveying +under this License, you may add to a covered work material governed by the terms of +that license document, provided that the further restriction does not survive such +relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in +the relevant source files, a statement of the additional terms that apply to those +files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements apply +either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly provided under +this License. Any attempt otherwise to propagate or modify it is void, and will +automatically terminate your rights under this License (including any patent licenses +granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated **(a)** provisionally, unless and until the +copyright holder explicitly and finally terminates your license, and **(b)** permanently, +if the copyright holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, this +is the first time you have received notice of violation of this License (for any +work) from that copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of +parties who have received copies or rights from you under this License. If your +rights have been terminated and not permanently reinstated, you do not qualify to +receive new licenses for the same material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or run a copy of the +Program. Ancillary propagation of a covered work occurring solely as a consequence of +using peer-to-peer transmission to receive a copy likewise does not require +acceptance. However, nothing other than this License grants you permission to +propagate or modify any covered work. These actions infringe copyright if you do not +accept this License. Therefore, by modifying or propagating a covered work, you +indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically receives a license +from the original licensors, to run, modify and propagate that work, subject to this +License. You are not responsible for enforcing compliance by third parties with this +License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an organization, or +merging organizations. If propagation of a covered work results from an entity +transaction, each party to that transaction who receives a copy of the work also +receives whatever licenses to the work the party's predecessor in interest had or +could give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if the predecessor +has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or +affirmed under this License. For example, you may not impose a license fee, royalty, +or other charge for exercise of rights granted under this License, and you may not +initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging +that any patent claim is infringed by making, using, selling, offering for sale, or +importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The work thus +licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, that +would be infringed by some manner, permitted by this License, of making, using, or +selling its contributor version, but do not include claims that would be infringed +only as a consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant patent +sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license +under the contributor's essential patent claims, to make, use, sell, offer for sale, +import and otherwise run, modify and propagate the contents of its contributor +version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent (such as an +express permission to practice a patent or covenant not to sue for patent +infringement). To “grant” such a patent license to a party means to make +such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of charge +and under the terms of this License, through a publicly available network server or +other readily accessible means, then you must either **(1)** cause the Corresponding +Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner consistent with +the requirements of this License, to extend the patent license to downstream +recipients. “Knowingly relying” means you have actual knowledge that, but +for the patent license, your conveying the covered work in a country, or your +recipient's use of the covered work in a country, would infringe one or more +identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a patent +license to some of the parties receiving the covered work authorizing them to use, +propagate, modify or convey a specific copy of the covered work, then the patent +license you grant is automatically extended to all recipients of the covered work and +works based on it. + +A patent license is “discriminatory” if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on the +non-exercise of one or more of the rights that are specifically granted under this +License. You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which you make +payment to the third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties who would receive +the covered work from you, a discriminatory patent license **(a)** in connection with +copies of the covered work conveyed by you (or copies made from those copies), or **(b)** +primarily for and in connection with specific products or compilations that contain +the covered work, unless you entered into that arrangement, or that patent license +was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to you +under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot convey a covered work so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not convey it at all. For example, if you +agree to terms that obligate you to collect a royalty for further conveying from +those to whom you convey the Program, the only way you could satisfy both those terms +and this License would be to refrain entirely from conveying the Program. + +### 13. Use with the GNU Affero General Public License + +Notwithstanding any other provision of this License, you have permission to link or +combine any covered work with a work licensed under version 3 of the GNU Affero +General Public License into a single combined work, and to convey the resulting work. +The terms of this License will continue to apply to the part which is the covered +work, but the special requirements of the GNU Affero General Public License, section +13, concerning interaction through a network will apply to the combination as such. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in spirit +to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that +a certain numbered version of the GNU General Public License “or any later +version” applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by the +Free Software Foundation. If the Program does not specify a version number of the GNU +General Public License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU +General Public License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no +additional obligations are imposed on any author or copyright holder as a result of +your choosing to follow a later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE +OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE +WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided above cannot be +given local legal effect according to their terms, reviewing courts shall apply local +law that most closely approximates an absolute waiver of all civil liability in +connection with the Program, unless a warranty or assumption of liability accompanies +a copy of the Program in return for a fee. + +_END OF TERMS AND CONDITIONS_ + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to +the public, the best way to achieve this is to make it free software which everyone +can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them +to the start of each source file to most effectively state the exclusion of warranty; +and each file should have at least the “copyright” line and a pointer to +where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like this +when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type 'show c' for details. + +The hypothetical commands `show w` and `show c` should show the appropriate parts of +the General Public License. Of course, your program's commands might be different; +for a GUI interface, you would use an “about box”. + +You should also get your employer (if you work as a programmer) or school, if any, to +sign a “copyright disclaimer” for the program, if necessary. For more +information on this, and how to apply and follow the GNU GPL, see +<>. + +The GNU General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may consider it +more useful to permit linking proprietary applications with the library. If this is +what you want to do, use the GNU Lesser General Public License instead of this +License. But first, please read +<>. diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 44a3de9..5849865 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,5 +2,5 @@ pandoc: 2.19.2 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-03-08T11:12Z +last_built: 2023-03-08T19:18Z diff --git a/docs/search.json b/docs/search.json index 0cd6f7f..57724dd 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -[{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Paul Egeler. Author. Andreas Gammelgaard Damsbo. Maintainer, contributor, copyright holder.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Egeler P (2023). REDCapCAST: REDCap Castellated data handling. R package version 23.3.2, https://github.com/agdamsbo/REDCapRITS.","code":"@Manual{, title = {REDCapCAST: REDCap Castellated data handling}, author = {Paul Egeler}, year = {2023}, note = {R package version 23.3.2}, url = {https://github.com/agdamsbo/REDCapRITS}, }"},{"path":"/index.html","id":"redcapcast","dir":"","previous_headings":"","what":"REDCap Castellated data handling","title":"REDCap Castellated data handling","text":"REDCap Castellated data handling using repeated instruments. Modified fork SpectrumHealthResearch/REDCapRITS. fork purely minded R usage includes implementations main REDCap_split function. Fork REDCapRITS: REDCap Repeating Instrument Table Splitter","code":""},{"path":"/reference/REDCap_split.html","id":null,"dir":"Reference","previous_headings":"","what":"Split REDCap repeating instruments table into multiple tables — REDCap_split","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"take output REDCap export split base table child tables repeating instrument. Metadata used determine fields included resultant table.","code":""},{"path":"/reference/REDCap_split.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"","code":"REDCap_split( records, metadata, primary_table_name = \"\", forms = c(\"repeating\", \"all\") )"},{"path":"/reference/REDCap_split.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"records Exported project records. May data.frame, response, character vector containing JSON API call. metadata Project metadata (data dictionary). May data.frame, response, character vector containing JSON API call. primary_table_name Name given list element primary output table (described README.md). Ignored forms = ''. forms Indicate whether create separate tables repeating instruments forms.","code":""},{"path":"/reference/REDCap_split.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"list \"data.frame\"s. number tables differ depending forms option selected. 'repeating': one base table one tables repeating instrument. '': data.frame instrument, regardless whether repeating instrument .","code":""},{"path":"/reference/REDCap_split.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"Paul W. Egeler, M.S., GStat","code":""},{"path":"/reference/REDCap_split.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"","code":"if (FALSE) { # Using an API call ------------------------------------------------------- library(RCurl) # Get the records records <- postForm( uri = api_url, # Supply your site-specific URI token = api_token, # Supply your own API token content = 'record', format = 'json', returnFormat = 'json' ) # Get the metadata metadata <- postForm( uri = api_url, # Supply your site-specific URI token = api_token, # Supply your own API token content = 'metadata', format = 'json' ) # Convert exported JSON strings into a list of data.frames REDCapRITS::REDCap_split(records, metadata) # Using a raw data export ------------------------------------------------- # Get the records records <- read.csv(\"/path/to/data/ExampleProject_DATA_2018-06-03_1700.csv\") # Get the metadata metadata <- read.csv(\"/path/to/data/ExampleProject_DataDictionary_2018-06-03.csv\") # Split the tables REDCapRITS::REDCap_split(records, metadata) # In conjunction with the R export script --------------------------------- # You must set the working directory first since the REDCap data export script # contains relative file references. setwd(\"/path/to/data/\") # Run the data export script supplied by REDCap. # This will create a data.frame of your records called 'data' source(\"ExampleProject_R_2018-06-03_1700.r\") # Get the metadata metadata <- read.csv(\"ExampleProject_DataDictionary_2018-06-03.csv\") # Split the tables REDCapRITS::REDCap_split(data, metadata) }"},{"path":"/reference/focused_metadata.html","id":null,"dir":"Reference","previous_headings":"","what":"focused_metadata — focused_metadata","title":"focused_metadata — focused_metadata","text":"Extracts limited metadata variables dataset","code":""},{"path":"/reference/focused_metadata.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"focused_metadata — focused_metadata","text":"","code":"focused_metadata(metadata, vars_in_data)"},{"path":"/reference/focused_metadata.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"focused_metadata — focused_metadata","text":"metadata dataframe containing metadata vars_in_data Vector variable names dataset","code":""},{"path":"/reference/focused_metadata.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"focused_metadata — focused_metadata","text":"dataframe containing metadata variables dataset","code":""},{"path":"/reference/match_fields_to_form.html","id":null,"dir":"Reference","previous_headings":"","what":"Match fields to forms — match_fields_to_form","title":"Match fields to forms — match_fields_to_form","text":"Match fields forms","code":""},{"path":"/reference/match_fields_to_form.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Match fields to forms — match_fields_to_form","text":"","code":"match_fields_to_form(metadata, vars_in_data)"},{"path":"/reference/match_fields_to_form.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Match fields to forms — match_fields_to_form","text":"metadata data frame containing field names form names vars_in_data character vector variable names","code":""},{"path":"/reference/match_fields_to_form.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Match fields to forms — match_fields_to_form","text":"data frame containing field names form names","code":""},{"path":"/reference/read_redcap_tables.html","id":null,"dir":"Reference","previous_headings":"","what":"Download REDCap data — read_redcap_tables","title":"Download REDCap data — read_redcap_tables","text":"Implementation REDCap_split focused data acquisition approach using REDCapR::redcap_read nad downloading specified fields, forms /events using built-focused_metadata including clean-. Works longitudinal projects repeating instruments.","code":""},{"path":"/reference/read_redcap_tables.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download REDCap data — read_redcap_tables","text":"","code":"read_redcap_tables( uri, token, records = NULL, fields = NULL, events = NULL, forms = NULL, raw_or_label = \"label\", split_forms = \"all\", generics = c(\"record_id\", \"redcap_event_name\", \"redcap_repeat_instrument\", \"redcap_repeat_instance\") )"},{"path":"/reference/read_redcap_tables.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download REDCap data — read_redcap_tables","text":"uri REDCap database uri token API token records records download fields fields download events events download forms forms download raw_or_label raw label tags split_forms Whether split \"repeating\" \"\" forms, default . generics vector auto-generated generic variable names ignore discarding empty rows","code":""},{"path":"/reference/read_redcap_tables.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download REDCap data — read_redcap_tables","text":"list instruments","code":""},{"path":"/reference/read_redcap_tables.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download REDCap data — read_redcap_tables","text":"","code":"# Examples will be provided later"},{"path":"/reference/redcap_wider.html","id":null,"dir":"Reference","previous_headings":"","what":"Redcap Wider — redcap_wider","title":"Redcap Wider — redcap_wider","text":"Converts list REDCap data frames long wide format. Handles longitudinal projects, yet repeated instruments.","code":""},{"path":"/reference/redcap_wider.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Redcap Wider — redcap_wider","text":"","code":"redcap_wider( list, event.glue = \"{.value}_{redcap_event_name}\", inst.glue = \"{.value}_{redcap_repeat_instance}\" )"},{"path":"/reference/redcap_wider.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Redcap Wider — redcap_wider","text":"list list data frames. event.glue dplyr::glue string repeated events naming inst.glue dplyr::glue string repeated instruments naming","code":""},{"path":"/reference/redcap_wider.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Redcap Wider — redcap_wider","text":"list data frames wide format.","code":""},{"path":"/reference/redcap_wider.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Redcap Wider — redcap_wider","text":"","code":"list <- list(data.frame(record_id = c(1,2,1,2), redcap_event_name = c(\"baseline\", \"baseline\", \"followup\", \"followup\"), age = c(25,26,27,28)), data.frame(record_id = c(1,2), redcap_event_name = c(\"baseline\", \"baseline\"), gender = c(\"male\", \"female\"))) redcap_wider(list) #> Joining with `by = join_by(record_id)` #> record_id age_baseline age_followup gender #> 1 1 25 27 male #> 2 2 26 28 female"},{"path":"/reference/sanitize_split.html","id":null,"dir":"Reference","previous_headings":"","what":"Sanitize list of data frames — sanitize_split","title":"Sanitize list of data frames — sanitize_split","text":"Removing empty rows","code":""},{"path":"/reference/sanitize_split.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sanitize list of data frames — sanitize_split","text":"","code":"sanitize_split( l, generic.names = c(\"record_id\", \"redcap_event_name\", \"redcap_repeat_instrument\", \"redcap_repeat_instance\") )"},{"path":"/reference/sanitize_split.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sanitize list of data frames — sanitize_split","text":"l list data frames. generic.names vector generic names excluded.","code":""},{"path":"/reference/sanitize_split.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sanitize list of data frames — sanitize_split","text":"list data frames generic names excluded.","code":""},{"path":"/reference/split_non_repeating_forms.html","id":null,"dir":"Reference","previous_headings":"","what":"Split a data frame into separate tables for each form — split_non_repeating_forms","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"Split data frame separate tables form","code":""},{"path":"/reference/split_non_repeating_forms.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"","code":"split_non_repeating_forms(table, universal_fields, fields)"},{"path":"/reference/split_non_repeating_forms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"table data frame universal_fields character vector fields included every table fields two-column matrix containing names fields included form","code":""},{"path":"/reference/split_non_repeating_forms.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"list data frames, one non-repeating form","code":""},{"path":"/reference/split_non_repeating_forms.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"","code":"# Create a table table <- data.frame( id = c(1, 2, 3, 4, 5), form_a_name = c(\"John\", \"Alice\", \"Bob\", \"Eve\", \"Mallory\"), form_a_age = c(25, 30, 25, 15, 20), form_b_name = c(\"John\", \"Alice\", \"Bob\", \"Eve\", \"Mallory\"), form_b_gender = c(\"M\", \"F\", \"M\", \"F\", \"F\") ) # Create the universal fields universal_fields <- c(\"id\") # Create the fields fields <- matrix( c(\"form_a_name\", \"form_a\", \"form_a_age\", \"form_a\", \"form_b_name\", \"form_b\", \"form_b_gender\", \"form_b\"), ncol = 2, byrow = TRUE ) # Split the table split_non_repeating_forms(table, universal_fields, fields) #> $form_a_age #> id #> 1 1 #> 2 2 #> 3 3 #> 4 4 #> 5 5 #>"},{"path":[]},{"path":"/news/index.html","id":"documentation-23-3-2","dir":"Changelog","previous_headings":"","what":"Documentation:","title":"REDCapCAST 23.3.2","text":"Page added. Vignettes follow. GithubActions tests added code coverage assessed. Badge galore..","code":""},{"path":[]},{"path":"/news/index.html","id":"new-name-redcapcast-23-3-1","dir":"Changelog","previous_headings":"","what":"New name: REDCapCAST","title":"REDCapCAST 23.3.1","text":"reflect new functions limitation working R, changed naming fork, still, course, maintaining status fork. versioning moved monthly naming convention. main goal package keep option export defined subset whole dataset REDCap server made possible REDCapR::redcap_read() function, combine work put REDCapRITS package handling longitudinal projects /projects repeated instruments.","code":""},{"path":"/news/index.html","id":"functions-23-3-1","dir":"Changelog","previous_headings":"","what":"Functions:","title":"REDCapCAST 23.3.1","text":"read_redcap_tables() NEW: function mainly implementation combined use REDCapR::readcap_read() REDCap_split() maintain focused nature REDCapR::readcap_read(), download specified data. Also implements tests valid form names event names. usual fall-back solution get data. redcap_wider() NEW: function pivots long data frames read_redcap_tables() using tidyr::pivot_wider(). focused_metadata() NEW: hidden helper function enable focused data acquisition approach handle subset metadata corresponding focused dataset.","code":""},{"path":"/news/index.html","id":"notes-23-3-1","dir":"Changelog","previous_headings":"","what":"Notes:","title":"REDCapCAST 23.3.1","text":"metadata handling IMPROVED: improved handling different column names matadata (DataDictionary) REDCap dependent whether acquired thorugh api og downloaded server.","code":""}] +[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 3, 29 June 2007Copyright © 2007 Free Software Foundation, Inc.  Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"GNU General Public License free, copyleft license software kinds works. licenses software practical works designed take away freedom share change works. contrast, GNU General Public License intended guarantee freedom share change versions program–make sure remains free software users. , Free Software Foundation, use GNU General Public License software; applies also work released way authors. can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge wish), receive source code can get want , can change software use pieces new free programs, know can things. protect rights, need prevent others denying rights asking surrender rights. Therefore, certain responsibilities distribute copies software, modify : responsibilities respect freedom others. example, distribute copies program, whether gratis fee, must pass recipients freedoms received. must make sure , , receive can get source code. must show terms know rights. Developers use GNU GPL protect rights two steps: (1) assert copyright software, (2) offer License giving legal permission copy, distribute /modify . developers’ authors’ protection, GPL clearly explains warranty free software. users’ authors’ sake, GPL requires modified versions marked changed, problems attributed erroneously authors previous versions. devices designed deny users access install run modified versions software inside , although manufacturer can . fundamentally incompatible aim protecting users’ freedom change software. systematic pattern abuse occurs area products individuals use, precisely unacceptable. Therefore, designed version GPL prohibit practice products. problems arise substantially domains, stand ready extend provision domains future versions GPL, needed protect freedom users. Finally, every program threatened constantly software patents. States allow patents restrict development use software general-purpose computers, , wish avoid special danger patents applied free program make effectively proprietary. prevent , GPL assures patents used render program non-free. precise terms conditions copying, distribution modification follow.","code":""},{"path":[]},{"path":"/LICENSE.html","id":"id_0-definitions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"0. Definitions","title":"GNU General Public License","text":"“License” refers version 3 GNU General Public License. “Copyright” also means copyright-like laws apply kinds works, semiconductor masks. “Program” refers copyrightable work licensed License. licensee addressed “”. “Licensees” “recipients” may individuals organizations. “modify” work means copy adapt part work fashion requiring copyright permission, making exact copy. resulting work called “modified version” earlier work work “based ” earlier work. “covered work” means either unmodified Program work based Program. “propagate” work means anything , without permission, make directly secondarily liable infringement applicable copyright law, except executing computer modifying private copy. Propagation includes copying, distribution (without modification), making available public, countries activities well. “convey” work means kind propagation enables parties make receive copies. Mere interaction user computer network, transfer copy, conveying. interactive user interface displays “Appropriate Legal Notices” extent includes convenient prominently visible feature (1) displays appropriate copyright notice, (2) tells user warranty work (except extent warranties provided), licensees may convey work License, view copy License. interface presents list user commands options, menu, prominent item list meets criterion.","code":""},{"path":"/LICENSE.html","id":"id_1-source-code","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"1. Source Code","title":"GNU General Public License","text":"“source code” work means preferred form work making modifications . “Object code” means non-source form work. “Standard Interface” means interface either official standard defined recognized standards body, , case interfaces specified particular programming language, one widely used among developers working language. “System Libraries” executable work include anything, work whole, () included normal form packaging Major Component, part Major Component, (b) serves enable use work Major Component, implement Standard Interface implementation available public source code form. “Major Component”, context, means major essential component (kernel, window system, ) specific operating system () executable work runs, compiler used produce work, object code interpreter used run . “Corresponding Source” work object code form means source code needed generate, install, (executable work) run object code modify work, including scripts control activities. However, include work’s System Libraries, general-purpose tools generally available free programs used unmodified performing activities part work. example, Corresponding Source includes interface definition files associated source files work, source code shared libraries dynamically linked subprograms work specifically designed require, intimate data communication control flow subprograms parts work. Corresponding Source need include anything users can regenerate automatically parts Corresponding Source. Corresponding Source work source code form work.","code":""},{"path":"/LICENSE.html","id":"id_2-basic-permissions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"2. Basic Permissions","title":"GNU General Public License","text":"rights granted License granted term copyright Program, irrevocable provided stated conditions met. License explicitly affirms unlimited permission run unmodified Program. output running covered work covered License output, given content, constitutes covered work. License acknowledges rights fair use equivalent, provided copyright law. may make, run propagate covered works convey, without conditions long license otherwise remains force. may convey covered works others sole purpose make modifications exclusively , provide facilities running works, provided comply terms License conveying material control copyright. thus making running covered works must exclusively behalf, direction control, terms prohibit making copies copyrighted material outside relationship . Conveying circumstances permitted solely conditions stated . Sublicensing allowed; section 10 makes unnecessary.","code":""},{"path":"/LICENSE.html","id":"id_3-protecting-users-legal-rights-from-anti-circumvention-law","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"3. Protecting Users’ Legal Rights From Anti-Circumvention Law","title":"GNU General Public License","text":"covered work shall deemed part effective technological measure applicable law fulfilling obligations article 11 WIPO copyright treaty adopted 20 December 1996, similar laws prohibiting restricting circumvention measures. convey covered work, waive legal power forbid circumvention technological measures extent circumvention effected exercising rights License respect covered work, disclaim intention limit operation modification work means enforcing, work’s users, third parties’ legal rights forbid circumvention technological measures.","code":""},{"path":"/LICENSE.html","id":"id_4-conveying-verbatim-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"4. Conveying Verbatim Copies","title":"GNU General Public License","text":"may convey verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice; keep intact notices stating License non-permissive terms added accord section 7 apply code; keep intact notices absence warranty; give recipients copy License along Program. may charge price price copy convey, may offer support warranty protection fee.","code":""},{"path":"/LICENSE.html","id":"id_5-conveying-modified-source-versions","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"5. Conveying Modified Source Versions","title":"GNU General Public License","text":"may convey work based Program, modifications produce Program, form source code terms section 4, provided also meet conditions: ) work must carry prominent notices stating modified , giving relevant date. b) work must carry prominent notices stating released License conditions added section 7. requirement modifies requirement section 4 “keep intact notices”. c) must license entire work, whole, License anyone comes possession copy. License therefore apply, along applicable section 7 additional terms, whole work, parts, regardless packaged. License gives permission license work way, invalidate permission separately received . d) work interactive user interfaces, must display Appropriate Legal Notices; however, Program interactive interfaces display Appropriate Legal Notices, work need make . compilation covered work separate independent works, nature extensions covered work, combined form larger program, volume storage distribution medium, called “aggregate” compilation resulting copyright used limit access legal rights compilation’s users beyond individual works permit. Inclusion covered work aggregate cause License apply parts aggregate.","code":""},{"path":"/LICENSE.html","id":"id_6-conveying-non-source-forms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"6. Conveying Non-Source Forms","title":"GNU General Public License","text":"may convey covered work object code form terms sections 4 5, provided also convey machine-readable Corresponding Source terms License, one ways: ) Convey object code , embodied , physical product (including physical distribution medium), accompanied Corresponding Source fixed durable physical medium customarily used software interchange. b) Convey object code , embodied , physical product (including physical distribution medium), accompanied written offer, valid least three years valid long offer spare parts customer support product model, give anyone possesses object code either (1) copy Corresponding Source software product covered License, durable physical medium customarily used software interchange, price reasonable cost physically performing conveying source, (2) access copy Corresponding Source network server charge. c) Convey individual copies object code copy written offer provide Corresponding Source. alternative allowed occasionally noncommercially, received object code offer, accord subsection 6b. d) Convey object code offering access designated place (gratis charge), offer equivalent access Corresponding Source way place charge. need require recipients copy Corresponding Source along object code. place copy object code network server, Corresponding Source may different server (operated third party) supports equivalent copying facilities, provided maintain clear directions next object code saying find Corresponding Source. Regardless server hosts Corresponding Source, remain obligated ensure available long needed satisfy requirements. e) Convey object code using peer--peer transmission, provided inform peers object code Corresponding Source work offered general public charge subsection 6d. separable portion object code, whose source code excluded Corresponding Source System Library, need included conveying object code work. “User Product” either (1) “consumer product”, means tangible personal property normally used personal, family, household purposes, (2) anything designed sold incorporation dwelling. determining whether product consumer product, doubtful cases shall resolved favor coverage. particular product received particular user, “normally used” refers typical common use class product, regardless status particular user way particular user actually uses, expects expected use, product. product consumer product regardless whether product substantial commercial, industrial non-consumer uses, unless uses represent significant mode use product. “Installation Information” User Product means methods, procedures, authorization keys, information required install execute modified versions covered work User Product modified version Corresponding Source. information must suffice ensure continued functioning modified object code case prevented interfered solely modification made. convey object code work section , , specifically use , User Product, conveying occurs part transaction right possession use User Product transferred recipient perpetuity fixed term (regardless transaction characterized), Corresponding Source conveyed section must accompanied Installation Information. requirement apply neither third party retains ability install modified object code User Product (example, work installed ROM). requirement provide Installation Information include requirement continue provide support service, warranty, updates work modified installed recipient, User Product modified installed. Access network may denied modification materially adversely affects operation network violates rules protocols communication across network. Corresponding Source conveyed, Installation Information provided, accord section must format publicly documented (implementation available public source code form), must require special password key unpacking, reading copying.","code":""},{"path":"/LICENSE.html","id":"id_7-additional-terms","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"7. Additional Terms","title":"GNU General Public License","text":"“Additional permissions” terms supplement terms License making exceptions one conditions. Additional permissions applicable entire Program shall treated though included License, extent valid applicable law. additional permissions apply part Program, part may used separately permissions, entire Program remains governed License without regard additional permissions. convey copy covered work, may option remove additional permissions copy, part . (Additional permissions may written require removal certain cases modify work.) may place additional permissions material, added covered work, can give appropriate copyright permission. Notwithstanding provision License, material add covered work, may (authorized copyright holders material) supplement terms License terms: ) Disclaiming warranty limiting liability differently terms sections 15 16 License; b) Requiring preservation specified reasonable legal notices author attributions material Appropriate Legal Notices displayed works containing ; c) Prohibiting misrepresentation origin material, requiring modified versions material marked reasonable ways different original version; d) Limiting use publicity purposes names licensors authors material; e) Declining grant rights trademark law use trade names, trademarks, service marks; f) Requiring indemnification licensors authors material anyone conveys material (modified versions ) contractual assumptions liability recipient, liability contractual assumptions directly impose licensors authors. non-permissive additional terms considered “restrictions” within meaning section 10. Program received , part , contains notice stating governed License along term restriction, may remove term. license document contains restriction permits relicensing conveying License, may add covered work material governed terms license document, provided restriction survive relicensing conveying. add terms covered work accord section, must place, relevant source files, statement additional terms apply files, notice indicating find applicable terms. Additional terms, permissive non-permissive, may stated form separately written license, stated exceptions; requirements apply either way.","code":""},{"path":"/LICENSE.html","id":"id_8-termination","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"8. Termination","title":"GNU General Public License","text":"may propagate modify covered work except expressly provided License. attempt otherwise propagate modify void, automatically terminate rights License (including patent licenses granted third paragraph section 11). However, cease violation License, license particular copyright holder reinstated () provisionally, unless copyright holder explicitly finally terminates license, (b) permanently, copyright holder fails notify violation reasonable means prior 60 days cessation. Moreover, license particular copyright holder reinstated permanently copyright holder notifies violation reasonable means, first time received notice violation License (work) copyright holder, cure violation prior 30 days receipt notice. Termination rights section terminate licenses parties received copies rights License. rights terminated permanently reinstated, qualify receive new licenses material section 10.","code":""},{"path":"/LICENSE.html","id":"id_9-acceptance-not-required-for-having-copies","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"9. Acceptance Not Required for Having Copies","title":"GNU General Public License","text":"required accept License order receive run copy Program. Ancillary propagation covered work occurring solely consequence using peer--peer transmission receive copy likewise require acceptance. However, nothing License grants permission propagate modify covered work. actions infringe copyright accept License. Therefore, modifying propagating covered work, indicate acceptance License .","code":""},{"path":"/LICENSE.html","id":"id_10-automatic-licensing-of-downstream-recipients","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"10. Automatic Licensing of Downstream Recipients","title":"GNU General Public License","text":"time convey covered work, recipient automatically receives license original licensors, run, modify propagate work, subject License. responsible enforcing compliance third parties License. “entity transaction” transaction transferring control organization, substantially assets one, subdividing organization, merging organizations. propagation covered work results entity transaction, party transaction receives copy work also receives whatever licenses work party’s predecessor interest give previous paragraph, plus right possession Corresponding Source work predecessor interest, predecessor can get reasonable efforts. may impose restrictions exercise rights granted affirmed License. example, may impose license fee, royalty, charge exercise rights granted License, may initiate litigation (including cross-claim counterclaim lawsuit) alleging patent claim infringed making, using, selling, offering sale, importing Program portion .","code":""},{"path":"/LICENSE.html","id":"id_11-patents","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"11. Patents","title":"GNU General Public License","text":"“contributor” copyright holder authorizes use License Program work Program based. work thus licensed called contributor’s “contributor version”. contributor’s “essential patent claims” patent claims owned controlled contributor, whether already acquired hereafter acquired, infringed manner, permitted License, making, using, selling contributor version, include claims infringed consequence modification contributor version. purposes definition, “control” includes right grant patent sublicenses manner consistent requirements License. contributor grants non-exclusive, worldwide, royalty-free patent license contributor’s essential patent claims, make, use, sell, offer sale, import otherwise run, modify propagate contents contributor version. following three paragraphs, “patent license” express agreement commitment, however denominated, enforce patent (express permission practice patent covenant sue patent infringement). “grant” patent license party means make agreement commitment enforce patent party. convey covered work, knowingly relying patent license, Corresponding Source work available anyone copy, free charge terms License, publicly available network server readily accessible means, must either (1) cause Corresponding Source available, (2) arrange deprive benefit patent license particular work, (3) arrange, manner consistent requirements License, extend patent license downstream recipients. “Knowingly relying” means actual knowledge , patent license, conveying covered work country, recipient’s use covered work country, infringe one identifiable patents country reason believe valid. , pursuant connection single transaction arrangement, convey, propagate procuring conveyance , covered work, grant patent license parties receiving covered work authorizing use, propagate, modify convey specific copy covered work, patent license grant automatically extended recipients covered work works based . patent license “discriminatory” include within scope coverage, prohibits exercise , conditioned non-exercise one rights specifically granted License. may convey covered work party arrangement third party business distributing software, make payment third party based extent activity conveying work, third party grants, parties receive covered work , discriminatory patent license () connection copies covered work conveyed (copies made copies), (b) primarily connection specific products compilations contain covered work, unless entered arrangement, patent license granted, prior 28 March 2007. Nothing License shall construed excluding limiting implied license defenses infringement may otherwise available applicable patent law.","code":""},{"path":"/LICENSE.html","id":"id_12-no-surrender-of-others-freedom","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"12. No Surrender of Others’ Freedom","title":"GNU General Public License","text":"conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. convey covered work satisfy simultaneously obligations License pertinent obligations, consequence may convey . example, agree terms obligate collect royalty conveying convey Program, way satisfy terms License refrain entirely conveying Program.","code":""},{"path":"/LICENSE.html","id":"id_13-use-with-the-gnu-affero-general-public-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"13. Use with the GNU Affero General Public License","title":"GNU General Public License","text":"Notwithstanding provision License, permission link combine covered work work licensed version 3 GNU Affero General Public License single combined work, convey resulting work. terms License continue apply part covered work, special requirements GNU Affero General Public License, section 13, concerning interaction network apply combination .","code":""},{"path":"/LICENSE.html","id":"id_14-revised-versions-of-this-license","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"14. Revised Versions of this License","title":"GNU General Public License","text":"Free Software Foundation may publish revised /new versions GNU General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies certain numbered version GNU General Public License “later version” applies , option following terms conditions either numbered version later version published Free Software Foundation. Program specify version number GNU General Public License, may choose version ever published Free Software Foundation. Program specifies proxy can decide future versions GNU General Public License can used, proxy’s public statement acceptance version permanently authorizes choose version Program. Later license versions may give additional different permissions. However, additional obligations imposed author copyright holder result choosing follow later version.","code":""},{"path":"/LICENSE.html","id":"id_15-disclaimer-of-warranty","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"15. Disclaimer of Warranty","title":"GNU General Public License","text":"WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION.","code":""},{"path":"/LICENSE.html","id":"id_16-limitation-of-liability","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"16. Limitation of Liability","title":"GNU General Public License","text":"EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MODIFIES /CONVEYS PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES.","code":""},{"path":"/LICENSE.html","id":"id_17-interpretation-of-sections-15-and-16","dir":"","previous_headings":"TERMS AND CONDITIONS","what":"17. Interpretation of Sections 15 and 16","title":"GNU General Public License","text":"disclaimer warranty limitation liability provided given local legal effect according terms, reviewing courts shall apply local law closely approximates absolute waiver civil liability connection Program, unless warranty assumption liability accompanies copy Program return fee. END TERMS CONDITIONS","code":""},{"path":"/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively state exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program terminal interaction, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, program’s commands might different; GUI interface, use “box”. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. information , apply follow GNU GPL, see . GNU General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License. first, please read .","code":" Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details."},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Paul Egeler. Author. Andreas Gammelgaard Damsbo. Maintainer, contributor, copyright holder.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Egeler P (2023). REDCapCAST: REDCap Castellated data handling. R package version 23.3.2, https://github.com/agdamsbo/REDCapRITS.","code":"@Manual{, title = {REDCapCAST: REDCap Castellated data handling}, author = {Paul Egeler}, year = {2023}, note = {R package version 23.3.2}, url = {https://github.com/agdamsbo/REDCapRITS}, }"},{"path":"/index.html","id":"redcapcast","dir":"","previous_headings":"","what":"REDCap Castellated data handling","title":"REDCap Castellated data handling","text":"REDCap Castellated data handling using repeated instruments. Modified fork SpectrumHealthResearch/REDCapRITS. fork purely minded R usage includes implementations main REDCap_split function. Fork REDCapRITS: REDCap Repeating Instrument Table Splitter","code":""},{"path":"/reference/REDCap_split.html","id":null,"dir":"Reference","previous_headings":"","what":"Split REDCap repeating instruments table into multiple tables — REDCap_split","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"take output REDCap export split base table child tables repeating instrument. Metadata used determine fields included resultant table.","code":""},{"path":"/reference/REDCap_split.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"","code":"REDCap_split( records, metadata, primary_table_name = \"\", forms = c(\"repeating\", \"all\") )"},{"path":"/reference/REDCap_split.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"records Exported project records. May data.frame, response, character vector containing JSON API call. metadata Project metadata (data dictionary). May data.frame, response, character vector containing JSON API call. primary_table_name Name given list element primary output table (described README.md). Ignored forms = ''. forms Indicate whether create separate tables repeating instruments forms.","code":""},{"path":"/reference/REDCap_split.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"list \"data.frame\"s. number tables differ depending forms option selected. 'repeating': one base table one tables repeating instrument. '': data.frame instrument, regardless whether repeating instrument .","code":""},{"path":"/reference/REDCap_split.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"Paul W. Egeler, M.S., GStat","code":""},{"path":"/reference/REDCap_split.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Split REDCap repeating instruments table into multiple tables — REDCap_split","text":"","code":"if (FALSE) { # Using an API call ------------------------------------------------------- library(RCurl) # Get the records records <- postForm( uri = api_url, # Supply your site-specific URI token = api_token, # Supply your own API token content = 'record', format = 'json', returnFormat = 'json' ) # Get the metadata metadata <- postForm( uri = api_url, # Supply your site-specific URI token = api_token, # Supply your own API token content = 'metadata', format = 'json' ) # Convert exported JSON strings into a list of data.frames REDCapRITS::REDCap_split(records, metadata) # Using a raw data export ------------------------------------------------- # Get the records records <- read.csv(\"/path/to/data/ExampleProject_DATA_2018-06-03_1700.csv\") # Get the metadata metadata <- read.csv(\"/path/to/data/ExampleProject_DataDictionary_2018-06-03.csv\") # Split the tables REDCapRITS::REDCap_split(records, metadata) # In conjunction with the R export script --------------------------------- # You must set the working directory first since the REDCap data export script # contains relative file references. setwd(\"/path/to/data/\") # Run the data export script supplied by REDCap. # This will create a data.frame of your records called 'data' source(\"ExampleProject_R_2018-06-03_1700.r\") # Get the metadata metadata <- read.csv(\"ExampleProject_DataDictionary_2018-06-03.csv\") # Split the tables REDCapRITS::REDCap_split(data, metadata) }"},{"path":"/reference/focused_metadata.html","id":null,"dir":"Reference","previous_headings":"","what":"focused_metadata — focused_metadata","title":"focused_metadata — focused_metadata","text":"Extracts limited metadata variables dataset","code":""},{"path":"/reference/focused_metadata.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"focused_metadata — focused_metadata","text":"","code":"focused_metadata(metadata, vars_in_data)"},{"path":"/reference/focused_metadata.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"focused_metadata — focused_metadata","text":"metadata dataframe containing metadata vars_in_data Vector variable names dataset","code":""},{"path":"/reference/focused_metadata.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"focused_metadata — focused_metadata","text":"dataframe containing metadata variables dataset","code":""},{"path":"/reference/match_fields_to_form.html","id":null,"dir":"Reference","previous_headings":"","what":"Match fields to forms — match_fields_to_form","title":"Match fields to forms — match_fields_to_form","text":"Match fields forms","code":""},{"path":"/reference/match_fields_to_form.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Match fields to forms — match_fields_to_form","text":"","code":"match_fields_to_form(metadata, vars_in_data)"},{"path":"/reference/match_fields_to_form.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Match fields to forms — match_fields_to_form","text":"metadata data frame containing field names form names vars_in_data character vector variable names","code":""},{"path":"/reference/match_fields_to_form.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Match fields to forms — match_fields_to_form","text":"data frame containing field names form names","code":""},{"path":"/reference/read_redcap_tables.html","id":null,"dir":"Reference","previous_headings":"","what":"Download REDCap data — read_redcap_tables","title":"Download REDCap data — read_redcap_tables","text":"Implementation REDCap_split focused data acquisition approach using REDCapR::redcap_read nad downloading specified fields, forms /events using built-focused_metadata including clean-. Works longitudinal projects repeating instruments.","code":""},{"path":"/reference/read_redcap_tables.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download REDCap data — read_redcap_tables","text":"","code":"read_redcap_tables( uri, token, records = NULL, fields = NULL, events = NULL, forms = NULL, raw_or_label = \"label\", split_forms = \"all\", generics = c(\"record_id\", \"redcap_event_name\", \"redcap_repeat_instrument\", \"redcap_repeat_instance\") )"},{"path":"/reference/read_redcap_tables.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download REDCap data — read_redcap_tables","text":"uri REDCap database uri token API token records records download fields fields download events events download forms forms download raw_or_label raw label tags split_forms Whether split \"repeating\" \"\" forms, default . generics vector auto-generated generic variable names ignore discarding empty rows","code":""},{"path":"/reference/read_redcap_tables.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download REDCap data — read_redcap_tables","text":"list instruments","code":""},{"path":"/reference/read_redcap_tables.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download REDCap data — read_redcap_tables","text":"","code":"# Examples will be provided later"},{"path":"/reference/redcap_wider.html","id":null,"dir":"Reference","previous_headings":"","what":"Redcap Wider — redcap_wider","title":"Redcap Wider — redcap_wider","text":"Converts list REDCap data frames long wide format. Handles longitudinal projects, yet repeated instruments.","code":""},{"path":"/reference/redcap_wider.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Redcap Wider — redcap_wider","text":"","code":"redcap_wider( list, event.glue = \"{.value}_{redcap_event_name}\", inst.glue = \"{.value}_{redcap_repeat_instance}\" )"},{"path":"/reference/redcap_wider.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Redcap Wider — redcap_wider","text":"list list data frames. event.glue dplyr::glue string repeated events naming inst.glue dplyr::glue string repeated instruments naming","code":""},{"path":"/reference/redcap_wider.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Redcap Wider — redcap_wider","text":"list data frames wide format.","code":""},{"path":"/reference/redcap_wider.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Redcap Wider — redcap_wider","text":"","code":"list <- list(data.frame(record_id = c(1,2,1,2), redcap_event_name = c(\"baseline\", \"baseline\", \"followup\", \"followup\"), age = c(25,26,27,28)), data.frame(record_id = c(1,2), redcap_event_name = c(\"baseline\", \"baseline\"), gender = c(\"male\", \"female\"))) redcap_wider(list) #> Joining with `by = join_by(record_id)` #> record_id age_baseline age_followup gender #> 1 1 25 27 male #> 2 2 26 28 female"},{"path":"/reference/sanitize_split.html","id":null,"dir":"Reference","previous_headings":"","what":"Sanitize list of data frames — sanitize_split","title":"Sanitize list of data frames — sanitize_split","text":"Removing empty rows","code":""},{"path":"/reference/sanitize_split.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sanitize list of data frames — sanitize_split","text":"","code":"sanitize_split( l, generic.names = c(\"record_id\", \"redcap_event_name\", \"redcap_repeat_instrument\", \"redcap_repeat_instance\") )"},{"path":"/reference/sanitize_split.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sanitize list of data frames — sanitize_split","text":"l list data frames. generic.names vector generic names excluded.","code":""},{"path":"/reference/sanitize_split.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sanitize list of data frames — sanitize_split","text":"list data frames generic names excluded.","code":""},{"path":"/reference/split_non_repeating_forms.html","id":null,"dir":"Reference","previous_headings":"","what":"Split a data frame into separate tables for each form — split_non_repeating_forms","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"Split data frame separate tables form","code":""},{"path":"/reference/split_non_repeating_forms.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"","code":"split_non_repeating_forms(table, universal_fields, fields)"},{"path":"/reference/split_non_repeating_forms.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"table data frame universal_fields character vector fields included every table fields two-column matrix containing names fields included form","code":""},{"path":"/reference/split_non_repeating_forms.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"list data frames, one non-repeating form","code":""},{"path":"/reference/split_non_repeating_forms.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Split a data frame into separate tables for each form — split_non_repeating_forms","text":"","code":"# Create a table table <- data.frame( id = c(1, 2, 3, 4, 5), form_a_name = c(\"John\", \"Alice\", \"Bob\", \"Eve\", \"Mallory\"), form_a_age = c(25, 30, 25, 15, 20), form_b_name = c(\"John\", \"Alice\", \"Bob\", \"Eve\", \"Mallory\"), form_b_gender = c(\"M\", \"F\", \"M\", \"F\", \"F\") ) # Create the universal fields universal_fields <- c(\"id\") # Create the fields fields <- matrix( c(\"form_a_name\", \"form_a\", \"form_a_age\", \"form_a\", \"form_b_name\", \"form_b\", \"form_b_gender\", \"form_b\"), ncol = 2, byrow = TRUE ) # Split the table split_non_repeating_forms(table, universal_fields, fields) #> $form_a_age #> id #> 1 1 #> 2 2 #> 3 3 #> 4 4 #> 5 5 #>"},{"path":[]},{"path":"/news/index.html","id":"documentation-23-3-2","dir":"Changelog","previous_headings":"","what":"Documentation:","title":"REDCapCAST 23.3.2","text":"Page added. Vignettes follow. GithubActions tests added code coverage assessed. Badge galore..","code":""},{"path":[]},{"path":"/news/index.html","id":"new-name-redcapcast-23-3-1","dir":"Changelog","previous_headings":"","what":"New name: REDCapCAST","title":"REDCapCAST 23.3.1","text":"reflect new functions limitation working R, changed naming fork, still, course, maintaining status fork. versioning moved monthly naming convention. main goal package keep option export defined subset whole dataset REDCap server made possible REDCapR::redcap_read() function, combine work put REDCapRITS package handling longitudinal projects /projects repeated instruments.","code":""},{"path":"/news/index.html","id":"functions-23-3-1","dir":"Changelog","previous_headings":"","what":"Functions:","title":"REDCapCAST 23.3.1","text":"read_redcap_tables() NEW: function mainly implementation combined use REDCapR::readcap_read() REDCap_split() maintain focused nature REDCapR::readcap_read(), download specified data. Also implements tests valid form names event names. usual fall-back solution get data. redcap_wider() NEW: function pivots long data frames read_redcap_tables() using tidyr::pivot_wider(). focused_metadata() NEW: hidden helper function enable focused data acquisition approach handle subset metadata corresponding focused dataset.","code":""},{"path":"/news/index.html","id":"notes-23-3-1","dir":"Changelog","previous_headings":"","what":"Notes:","title":"REDCapCAST 23.3.1","text":"metadata handling IMPROVED: improved handling different column names matadata (DataDictionary) REDCap dependent whether acquired thorugh api og downloaded server.","code":""}] diff --git a/docs/sitemap.xml b/docs/sitemap.xml index f9fdf16..54ae66d 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -3,6 +3,9 @@ /404.html + + /LICENSE.html + /authors.html