GNU General Public License
@@ -127,11 +58,10 @@GNU General Public License
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
--Preamble
+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.
@@ -143,12 +73,10 @@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
+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.
@@ -158,9 +86,8 @@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
+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.
@@ -168,31 +95,26 @@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
+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
+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
+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
+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”. @@ -200,15 +122,12 @@
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.
+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
+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. @@ -218,22 +137,19 @@
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 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
+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 @@ -245,34 +161,29 @@
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.
+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
+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
+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
+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
+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.
@@ -282,101 +193,90 @@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
+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
+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
+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
+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
+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
+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
+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.
-<one line to give the program's name and a brief idea of what it does.>
-Copyright (C) 2018 John Muschelli
-
-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 <http://www.gnu.org/licenses/>.<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) 2018 John Muschelli
+
+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 <http://www.gnu.org/licenses/>.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:
-ottrpal Copyright (C) 2021 John Muschelli
-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.ottrpal Copyright (C) 2021 John Muschelli
+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 <http://www.gnu.org/licenses/>.
-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 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
+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 <http://www.gnu.org/licenses/>.
+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 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
NA
-Purpose/implementation Section
--What changes are being implemented in this Pull Request?
+ --
-
+
@@ -79,385 +75,177 @@
- +-
getting-started
- Source:vignettes/getting-started.Rmd+ Source:vignettes/getting-started.Rmdgetting-started.Rmd--Intro to ottrpal
-
-ottrpalconverts a Bookdown repository into a Leanpub-ready set of files. The output rendered files from this package can be published using the Github writing mode on Leanpub.If you aren’t familiar with
-Bookdownyou may want with their tutorials.---Installing ottrpal:
-You can install
-ottrpalfrom GitHub with:You will need to use the remotes package (and will need to install it if you don’t have it).
---if (!("remotes" %in% installed.packages())) { - install.packages("remotes") -} -if (!("ottrpal" %in% installed.packages())) { - remotes::install_github("jhudsl/ottrpal") -}
--Required files:
-Before you are ready to run
-ottrpal, you will need the following files (which are standard in aBookdownrepository):
-- a_bookdown.ymlfile which lists the.Rmdfiles that are to be rendered in armd:category (see example file). -.Rmdfiles which contain the chapter content (including yourindex.Rmdfile whichBookdownhas). - animagesdirectory that contains any images that are referenced in the chapters. -.bibfile(s) to complete any citation renders (see example file).Optionally:. - a
-Book.txtfile which lists the order of the chapters/quiz files (this can be autogenerated withottrpal) (see example file).
-- a directory containing quizzes in the form of.mdfiles which have been written using the Markua formatting specifications (see example folder).Here’s an example of what the Bookdown file set up (which ottrpal will look for) might be set up like:
-
+A_Bookdown_Repo -├── _bookdown.yml -├── index.Rmd -├── 01-chapter_one.Rmd -├── docs -│ └── ... -├── references.bib -├── quizzes -│ ├── quiz_1.md -│ └── ... -├── resources/images -│ ├── some-figures.png -│ └── ... -└── Book.txt+Intro to ottrpal +
+
+ottrpalcontains tools and functions to be used with an +OTTR repository +course. It converts an OTTR course +(Open-Source Tools for Training Resources) into a files ready for upload +to Massive Open Online Courses (MOOCs): Coursera and Leanpub.-
+
- Go to the main OTTR guide +for how to start creating courses with OTTR. +
- +Read +the ottrpal package documentation here. +
--Set up example data
-If you’d like to use our example repository you can fork it on Github and clone it to your own computer Follow these instructions to fork and then you can clone it using a command line.
-But for the purposes of this example we will download a zip file of the files we need and set those up using this function:
---# Run this to get the files we need -example_files <- ottrpal::example_repo_setup()
Each of your Rmds needs to have a chunk of code with this at the beginning of the file:
-ottrpal::set_knitr_image_path()This will ensure that the images are stored in the correct place and will be rendered correctly both in
+Bookdownand in Leanpub.+-Optional input files: +
+-
+
-
+a
+
Book.txtfile which lists the order of the +chapters/quiz files (this can be autogenerated with +ottrpal) (see example +file).
+
+ - a directory containing quizzes in the form of
.mdfiles +which have been written using the Markua +formatting specifications (see example +folder).
+
+ - A TSV file specifying
url,chapt_title, +img_pathSee this (https://github.com/jhudsl/OTTR_Template/blob/main/resources/chapt_screen_images/chapter_urls.tsv).
+
--Running ottrpal
-The
-ottrpalpackage converts your files using this main function (which we won’t run just yet).
-ottrpal::bookdown_to_leanpub()By default,
+ottrpalwill re-run abookdown::render_book("index.Rmd")rendering of your chapters first before converting the files to the Leanpub ready format. It will only process theRmdfiles that are listed in the_bookdown.ymlfile. However, if you wish to skip this step, you can setrender = FALSEwhen running theottrpal::bookdown_to_leanpub()function.+-Set up an OTTR GitHub repository +
+Follow the instructions +here to set up your own OTTR GitHub repository for a new course.
--About the output files
-Leanpub’s Github writing mode will look for a directory called
+manuscriptto publish from. You should not edit the files inmanuscript/by hand since a re-run ofottrpalwill cause your changes to be overwritten.+-Running ottrpal +
+In the base of your OTTR repository, you can run this command to set +up a Leanpub version of your course. The
+ottrpalpackage +converts your files using this base function, where +base_urlis where the OTTR course pages are published, the +GitHub pages URL.
+ottrpal::bookdown_to_embed_leanpub(base_url = "https://jhudatascience.org/OTTR_Template/")By default,
ottrpalwill re-run a +bookdown::render_book("index.Rmd")rendering of your +chapters first before converting the files to the Leanpub ready format. +However, if you wish to skip this step, you can set +render = FALSEwhen running the +ottrpal::bookdown_to_embed_leanpub()function.--About the Book.txt file:
-Leanpub requires a
-Book.txtfile to know what order the chapters/quizzes should be published.By default, your
-Book.txtfile will not be autogenerated butottrpalwill look in your given directory for an existingBook.txtfile which it will copy over to the output directory.You can create a
-Book.txtfile manually, or if your quizzes and chapters are numbered,ottrpalcan create theBook.txtfile based on the numbers going from low to high and quizzes following chapters of the same number. (e.g.quiz_03.mdwill be placed after03-some_chapter_file.Rmd).To have
-ottrpalattempt to autogenerate this file with the main function you can setmake_book_txttoTRUE. If noBook.txtfile is found andmake_book_txtis set toFALSE(this is the default setting),ottrpalwill fail.So to run the main function and also have it make a
-Book.txtfile for us, we can run the following:--ottrpal::bookdown_to_leanpub(make_book_txt = TRUE)
-## Looking for bookdown file in /home/rstudio/GitRepos/ottrpal/vignettes
-## Processing these files: -## index.Rmd -## 01-intro.Rmd -## 02-example-chapter.Rmd
-## Rendering the Book
-## index_file is /home/rstudio/GitRepos/ottrpal/vignettes/index.Rmd
-## Warning in bookdown::render_book(input = index_file, output_format = -## output_format, : The argument 'clean_envir' has been deprecated and will be -## removed in future versions of bookdown.
-## /usr/lib/rstudio-server/bin/pandoc/pandoc +RTS -K512m -RTS Course_Name.md --to html4 --from markdown+autolink_bare_uris+tex_math_single_backslash --output Course_Name.html --lua-filter /usr/local/lib/R/site-library/bookdown/rmarkdown/lua/custom-environment.lua --lua-filter /usr/local/lib/R/site-library/rmarkdown/rmarkdown/lua/pagebreak.lua --lua-filter /usr/local/lib/R/site-library/rmarkdown/rmarkdown/lua/latex-div.lua --metadata-file /tmp/RtmptI3G0C/file4ac41729876 --wrap preserve --citeproc --standalone --section-divs --table-of-contents --toc-depth 3 --template /usr/local/lib/R/site-library/bookdown/templates/gitbook.html --highlight-style pygments --number-sections --citeproc --include-in-header /tmp/RtmptI3G0C/rmarkdown-str4ac73aeac9e.html --mathjax
-## -## Output created: docs/index.html
-## Copying Resources
-## Copying Docs folder
-## Copying bib files
-## Autogenerated Book.txt saved to: manuscript/Book.txt
-## Leanpub ready files are saved to manuscript Go to https://leanpub.com/ to publish them using the GitHub writing mode.Alternatively, we could run
-bookdown_to_book_txt()function on its own:--ottrpal::bookdown_to_book_txt()
-## Autogenerated Book.txt saved to: manuscript/Book.txtAlso note that any
-index.Rmdwill always be placed first and anyabout.Rmdfile will be placed last.We can take a peek at what the autogenerated file looks like. By default the
- -Book.txtfile is saved to themanuscriptdirectory along with all the other Leanpub-ready files.
+## [1] "index.Rmd" "01-intro.Rmd" "02-example-chapter.Rmd"+-About the Book.txt file: +
+Leanpub requires a
+Book.txt+file to know what order the chapters/quizzes should be published.By default, your
+Book.txtfile will not be +autogenerated butottrpalwill look in your given directory +for an existingBook.txtfile which it will copy over to +the output directory.You can create a
+Book.txtfile manually, or if your +quizzes and chapters are numbered,ottrpalcan create the +Book.txtfile based on the numbers going from low to high +and quizzes following chapters of the same number. +(e.g.quiz_03.mdwill be placed after +03-some_chapter_file.Rmd).To have
+ottrpalattempt to autogenerate this file, set +make_book_txttoTRUE.
+ottrpal::bookdown_to_embed_leanpub(base_url = "https://jhudatascience.org/OTTR_Template/", + make_book_txt = TRUE)If no
+Book.txtfile is found and +make_book_txtis set toFALSE(this is the +default setting),ottrpalwill fail.A
+ottrpalautogeneratedBook.txtfile might +look something like this:
+index.Rmd +01-chapter.Rmd +quiz_1.md +02-chapter.Rmd +quiz_2.md +about.RmdAlso note that any
index.Rmdwill always be placed first +and anyabout.Rmdfile will be placed last.--Setting up quizzes:
-First, we will set up a directory to put our quizzes in.
---quiz_dir <- "quizzes" -if(!dir.exists(quiz_dir)) { - dir.create(quiz_dir) -}
By default, ottrpal will look for a folder called
-quizzes/to find your quiz.mdfiles. If your quizzes are located somewhere else, you will need to use thequiz_dirargument to specify that:
-ottrpal::bookdown_to_leanpub(quiz_dir = "some_other_directory")Leanpub can be very particular about the formatting of the quizzes, so there are funtions to help you check the formatting of your quiz.
-In the main argument, you can set
-run_quiz_checkstoTRUE(the default isFALSE).
-ottrpal::bookdown_to_leanpub(run_quiz_checks = TRUE)But the quiz checks can also be run separately using the
-check_quizzes()function. It will again assume you have a directory calledquizzesunless you specify otherwise:We can take a look at how
-check_quizzes()runs using a quiz examples: one that passes the checks and one that fails.--# Set up an good example quiz -good_quiz_path <- ottrpal::good_quiz_path() - -dest_quiz_path <- file.path("quizzes", basename(good_quiz_path)) - -if (!file.exists(dest_quiz_path)){ - file.copy(from = good_quiz_path, - to = dest_quiz_path) -}
-## [1] TRUERun
-check_quizzes()to check all quizzes in the directory.--quiz_checklist <- ottrpal::check_quizzes(quiz_dir = "quizzes")
-## -## Checking quiz: quizzes/quiz_good.md
-## Checking question: First question to as ... in quiz: quiz_good.md
-## Checking question: Example without choo ... in quiz: quiz_good.md
-## Checking question: Question example wit ... in quiz: quiz_good.md
-## Checking question: A more complicated e ... in quiz: quiz_good.md
-## -## No question errors to report!We can take a look at what a typical quiz format looks like:
- -
-## [1] "" -## [2] "{quiz, id: quiz_name_here, attempts: 10}" -## [3] "" -## [4] "## Template quiz" -## [5] "" -## [6] "Put any other instructions your quiz takers need to know here like, Choose the best answer."Now let’s add in a bad quiz and see how the report changes.
---# Set up an good example quiz -bad_quiz_path <- ottrpal::bad_quiz_path() - -dest_quiz_path <- file.path("quizzes", basename(bad_quiz_path)) - -if (!file.exists(dest_quiz_path)){ - file.copy(from = bad_quiz_path, - to = dest_quiz_path) -}
-## [1] TRUELet’s re-run
-check_quizzes().--quiz_checklist <- ottrpal::check_quizzes(quiz_dir = "quizzes")
-## -## Checking quiz: quizzes/quiz_bad.md
-## Checking question: It would be a shame ... in quiz: quiz_bad.md
-## Warning in FUN(X[[i]], ...): Colon detected in question on lines: 7 in question -## starting with:It would be a shame ... in quiz: quiz_bad.md
-## Checking question: What a shame if we p ... in quiz: quiz_bad.md
-## Checking question: Shame shame if we sa ... in quiz: quiz_bad.md
-## Checking question: What if we don't put ... in quiz: quiz_bad.md
-## Warning in FUN(X[[i]], ...): No correct answers provided for What if we don't -## put ... in quiz: quiz_bad.md
-## Checking question: What if only give co ... in quiz: quiz_bad.md
-## Warning in FUN(X[[i]], ...): No incorrect answer options provided for What if -## only give co ... in quiz: quiz_bad.md
-## -## Checking quiz: quizzes/quiz_good.md
-## Checking question: First question to as ... in quiz: quiz_good.md
-## Checking question: Example without choo ... in quiz: quiz_good.md
-## Checking question: Question example wit ... in quiz: quiz_good.md
-## Checking question: A more complicated e ... in quiz: quiz_good.md
-## -## Question error report saved to 'question_error_report.tsv'We have some warning messages about various items and the errors have been saved to
-'question_error_report.tsv'which we can read in and check out. Each line shows an error detected, what quiz file it was detected in, the line it’s roughly associated with and the warning message which explains what the problem is.--error_df <- readr::read_tsv("question_error_report.tsv")
-## -## ── Column specification ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -## cols( -## question_names = col_character(), -## quiz = col_character(), -## warning_msg = col_character(), -## related_index = col_double() -## )--error_df
-## # A tibble: 3 x 4 -## question_names quiz warning_msg related_index -## <chr> <chr> <chr> <dbl> -## 1 It would be a shame if we pu… quiz_… Colon detected in question… 7 -## 2 What if we don't put a corre… quiz_… No correct answers provide… 31 -## 3 What if only give correct an… quiz_… No incorrect answer option… 38Now you would just need to go into each of those files and fix the stated problem. Then you can re-run
+check_quizzes()and see if the warning is resolved.+- @@ -473,11 +261,13 @@Setting up quizzes: +
+By default, ottrpal will look for a folder called +
+quizzes/to find your quiz.mdfiles. If your +quizzes are located somewhere else, you will need to use the +quiz_dirargument to specify that:
+ottrpal::bookdown_to_embed_leanpub(base_url = "https://jhudatascience.org/OTTR_Template/", + make_book_txt = TRUE, + quiz_dir = "some_directory")If you don’t have quizzes, you can say
quiz_dir = NULL+to skip all quiz steps.@@ -486,5 +276,7 @@
+ + diff --git a/docs/articles/index.html b/docs/articles/index.html index a9659b8..3e33b63 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,66 +1,12 @@ - - - - - - - -
Articles • ottrpal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Articles • ottrpal - + + - - - --- - + + diff --git a/docs/authors.html b/docs/authors.html index e731c2d..e0fc712 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,66 +1,12 @@ - - - - - - - -- - - -+-+- getting-started +
- +
Authors • ottrpal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Authors and Citation • ottrpal - + + - - - - --- + - - -+-- - + + diff --git a/docs/index.html b/docs/index.html index e8fe190..b99317f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,21 +5,22 @@ --@@ -146,22 +101,20 @@Authors
+ ++-+Citation
+ Source:DESCRIPTION+-
-
- - - -
- - - -
-
-
Carrie Wright. Contributor. -
-
-
Savonen C, Muschelli J (2024). +ottrpal: Companion Tools for Open-Source Tools for Training Resources (OTTR). +R package version 1.3.0, https://github.com/jhudsl/ottrpal. +
+@Manual{, + title = {ottrpal: Companion Tools for Open-Source Tools for Training Resources (OTTR)}, + author = {Candace Savonen and John Muschelli}, + year = {2024}, + note = {R package version 1.3.0}, + url = {https://github.com/jhudsl/ottrpal}, +}Authors
-Tools for Creating Automated Courses • ottrpal - +Companion Tools for Open-Source Tools for Training Resources (OTTR) • ottrpal + - - + + + +@@ -32,23 +33,17 @@-
-
+
@@ -84,165 +79,143 @@
+ -- -
-ottrpalconverts a Bookdown repository into a Leanpub-ready set of files. The output rendered files from this package can be published using the Github writing mode on Leanpub.Read the full documentation here.
---Required files:
-Before you are ready to run
+ottrpal, you will need the following files (which are standard in aBookdownrepository):+ +-ottrpalconverts an OTTR course (Open-source Tools for Training Resources) into a files ready for upload to Massive Open Online Courses (MOOCs): Coursera and Leanpub.-
-
- a
_bookdown.ymlfile which lists the.Rmdfiles that are to be rendered in armd:category (see example file).
- -
-
.Rmdfiles which contain the chapter content (including yourindex.Rmdfile whichBookdownhas).
- - an
imagesdirectory that contains any images that are referenced in the chapters.
+ - Go to the main OTTR guide for how to start creating courses with OTTR.
-
-
.bibfile(s) to complete any citation renders (see example file).
+Read the ottrpal package documentation here.
Optionally:
--
-
-
-a
Book.txtfile which lists the order of the chapters/quiz files (this can be autogenerated withottrpal) (see example file).
- - a directory containing quizzes in the form of
.mdfiles which have been written using the Markua formatting specifications (see example folder).
-
Here’s an example of what the Bookdown file set up (which ottrpal will look for) might be set up like:
-
-A_Bookdown_Repo -├── _bookdown.yml -├── index.Rmd -├── 01-chapter_one.Rmd -├── docs -│ └── ... -├── references.bib -├── quizzes -│ ├── quiz_1.md -│ └── ... -├── resources/images -│ ├── some-figures.png -│ └── ... -└── Book.txt---Using the example repository:
-If you’d like to use our example repository you can fork it on Github and clone it to your own computer Follow these instructions to fork and then you can clone it using a command like:
-
-git clone https://github.com/{organization}/OTTR_Quizzes.gitBut replace
-{organization}with the location of your forked repository.--Installing ottrpal:
+++Using the example repository: +
+If you’d like to use our example repository you can fork it on Github and clone it to your own computer Follow these instructions to fork and then you can clone it using a command like:
+
+{sh} git clone https://github.com/{organization}/OTTR_Quizzes.gitBut replace{organization}with the location of your forked repository.+-Installing ottrpal: +
You can install
-ottrpalfrom GitHub with:You will need to use the remotes package (and will need to install it if you don’t have it).
---if (!("remotes" %in% installed.packages())) { - install.packages("remotes") -} -remotes::install_github("jhudsl/ottrpal")
---Setting up the Rmds and images folder:
-Each of your Rmds needs to have this chunk of code in the beginning of the file:
-
-```{r, include = FALSE} -ottrpal::set_knitr_image_path() -```This will ensure that the images are stored in the correct place and will be rendered correctly both in
-Bookdownand in Leanpub.---Running ottrpal
-The
-ottrpalpackage converts your files using this main function:
-ottrpal::bookdown_to_leanpub()By default,
-ottrpalwill re-run abookdown::render_book("index.Rmd")rendering of your chapters first before converting the files to the Leanpub ready format. However, if you wish to skip this step, you can setrender = FALSEwhen running theottrpal::bookdown_to_leanpub()function.-+-About the Book.txt file:
-Leanpub requires a
+Book.txtfile to know what order the chapters/quizzes should be published.
+install.packages("ottrpal")If you want the development version (not advised) you can install using the
+remotespacakge to install from GitHub.++
if (!("remotes" %in% installed.packages())) { + install.packages("remotes") +} +remotes::install_github("jhudsl/ottrpal")++Running ottrpal +
+The
+ottrpalpackage converts your files using one of these main functions:
+{r} ottrpal::bookdown_to_embed_leanpub()By default,
+ottrpalwill re-run abookdown::render_book("index.Rmd")rendering of your chapters first before converting the files to the Leanpub ready format. However, if you wish to skip this step, you can setrender = FALSEwhen running theottrpal::bookdown_to_embed_leanpub()function.+-About the Book.txt file: +
+Leanpub requires a
Book.txtfile to know what order the chapters/quizzes should be published.By default, your
Book.txtfile will not be autogenerated butottrpalwill look in your given directory for an existingBook.txtfile which it will copy over to the output directory.You can create a
Book.txtfile manually, or if your quizzes and chapters are numbered,ottrpalcan create theBook.txtfile based on the numbers going from low to high and quizzes following chapters of the same number. (e.g.quiz_03.mdwill be placed after03-some_chapter_file.Rmd).To have
-ottrpalattempt to autogenerate this file, setmake_book_txttoTRUE.
+ottrpal::bookdown_to_leanpub(make_book_txt = TRUE){r} ottrpal::bookdown_to_embed_leanpub(make_book_txt = TRUE)If no
Book.txtfile is found andmake_book_txtis set toFALSE(this is the default setting),ottrpalwill fail.A ottrpal autogenerated
-Book.txtfile might look something like this:
+index.Rmd -01-chapter.Rmd -quiz_1.md -02-chapter.Rmd -quiz_2.md -about.Rmdindex.Rmd +01-chapter.Rmd +quiz_1.md +02-chapter.Rmd +quiz_2.md +about.RmdAlso note that any
index.Rmdwill always be placed first and anyabout.Rmdfile will be placed last.--Setting up quizzes:
++-Setting up quizzes: +
By default, ottrpal will look for a folder called
-quizzes/to find your quiz.mdfiles. If your quizzes are located somewhere else, you will need to use thequiz_dirargument to specify that:
+ottrpal::bookdown_to_leanpub(quiz_dir = "some_directory"){r} ottrpal::bookdown_to_embed_leanpub(quiz_dir = "some_directory") - a
