diff --git a/README.md b/README.md index a79db48..c156ca3 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ To install this package on R fram R console: >library(devtools) ->library(reotes) +>library(remotes) >install_github("ecor/geotopbricks") diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..721b44e --- /dev/null +++ b/docs/404.html @@ -0,0 +1,100 @@ + + + + + + + +Page not found (404) • geotopbricks + + + + + + + + + + + +
+
+ + + + +
+
+ + +Content not found. Please use links in the navbar. + +
+ + + +
+ + + + +
+ + + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html new file mode 100644 index 0000000..83cb19c --- /dev/null +++ b/docs/LICENSE-text.html @@ -0,0 +1,748 @@ + +License • geotopbricks + + +
+
+ + + +
+
+ + +
GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 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
+
+  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.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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:
+
+    <program>  Copyright (C) <year>  <name of author>
+    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>.
+
+ +
+ + + +
+ + + +
+ + + + + + + + diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 0000000..3405016 --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,95 @@ + +Authors and Citation • geotopbricks + + +
+
+ + + +
+
+
+ + + +
  • +

    Emanuele Cordano. Maintainer. +

    +
  • +
+
+
+

Citation

+ Source: DESCRIPTION +
+
+ + +

Cordano E (2024). +geotopbricks: An R Plug-in for the Distributed Hydrological Model GEOtop. +R package version 1.5.8.2, www.geotop.org, https://www.rendena100.eu/en/geotop-hydrological-model.html, https://github.com/ecor/geotopbricks, https://zenodo.org/record/8228413. +

+
@Manual{,
+  title = {geotopbricks: An R Plug-in for the Distributed Hydrological Model GEOtop},
+  author = {Emanuele Cordano},
+  year = {2024},
+  note = {R package version 1.5.8.2, www.geotop.org, https://www.rendena100.eu/en/geotop-hydrological-model.html, https://github.com/ecor/geotopbricks},
+  url = {https://zenodo.org/record/8228413},
+}
+ +
+ +
+ + + +
+ + + + + + + + diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css new file mode 100644 index 0000000..5a85941 --- /dev/null +++ b/docs/bootstrap-toc.css @@ -0,0 +1,60 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ + +/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */ + +/* All levels of nav */ +nav[data-toggle='toc'] .nav > li > a { + display: block; + padding: 4px 20px; + font-size: 13px; + font-weight: 500; + color: #767676; +} +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 19px; + color: #563d7c; + text-decoration: none; + background-color: transparent; + border-left: 1px solid #563d7c; +} +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 18px; + font-weight: bold; + color: #563d7c; + background-color: transparent; + border-left: 2px solid #563d7c; +} + +/* Nav: second level (shown on .active) */ +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} +nav[data-toggle='toc'] .nav .nav > li > a { + padding-top: 1px; + padding-bottom: 1px; + padding-left: 30px; + font-size: 12px; + font-weight: normal; +} +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 29px; +} +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 28px; + font-weight: 500; +} + +/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */ +nav[data-toggle='toc'] .nav > .active > ul { + display: block; +} diff --git a/docs/bootstrap-toc.js b/docs/bootstrap-toc.js new file mode 100644 index 0000000..1cdd573 --- /dev/null +++ b/docs/bootstrap-toc.js @@ -0,0 +1,159 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ +(function() { + 'use strict'; + + window.Toc = { + helpers: { + // return all matching elements in the set, or their descendants + findOrFilter: function($el, selector) { + // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/ + // http://stackoverflow.com/a/12731439/358804 + var $descendants = $el.find(selector); + return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])'); + }, + + generateUniqueIdBase: function(el) { + var text = $(el).text(); + var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-'); + return anchor || el.tagName.toLowerCase(); + }, + + generateUniqueId: function(el) { + var anchorBase = this.generateUniqueIdBase(el); + for (var i = 0; ; i++) { + var anchor = anchorBase; + if (i > 0) { + // add suffix + anchor += '-' + i; + } + // check if ID already exists + if (!document.getElementById(anchor)) { + return anchor; + } + } + }, + + generateAnchor: function(el) { + if (el.id) { + return el.id; + } else { + var anchor = this.generateUniqueId(el); + el.id = anchor; + return anchor; + } + }, + + createNavList: function() { + return $(''); + }, + + createChildNavList: function($parent) { + var $childList = this.createNavList(); + $parent.append($childList); + return $childList; + }, + + generateNavEl: function(anchor, text) { + var $a = $(''); + $a.attr('href', '#' + anchor); + $a.text(text); + var $li = $('
  • '); + $li.append($a); + return $li; + }, + + generateNavItem: function(headingEl) { + var anchor = this.generateAnchor(headingEl); + var $heading = $(headingEl); + var text = $heading.data('toc-text') || $heading.text(); + return this.generateNavEl(anchor, text); + }, + + // Find the first heading level (`

    `, then `

    `, etc.) that has more than one element. Defaults to 1 (for `

    `). + getTopLevel: function($scope) { + for (var i = 1; i <= 6; i++) { + var $headings = this.findOrFilter($scope, 'h' + i); + if ($headings.length > 1) { + return i; + } + } + + return 1; + }, + + // returns the elements for the top level, and the next below it + getHeadings: function($scope, topLevel) { + var topSelector = 'h' + topLevel; + + var secondaryLevel = topLevel + 1; + var secondarySelector = 'h' + secondaryLevel; + + return this.findOrFilter($scope, topSelector + ',' + secondarySelector); + }, + + getNavLevel: function(el) { + return parseInt(el.tagName.charAt(1), 10); + }, + + populateNav: function($topContext, topLevel, $headings) { + var $context = $topContext; + var $prevNav; + + var helpers = this; + $headings.each(function(i, el) { + var $newNav = helpers.generateNavItem(el); + var navLevel = helpers.getNavLevel(el); + + // determine the proper $context + if (navLevel === topLevel) { + // use top level + $context = $topContext; + } else if ($prevNav && $context === $topContext) { + // create a new level of the tree and switch to it + $context = helpers.createChildNavList($prevNav); + } // else use the current $context + + $context.append($newNav); + + $prevNav = $newNav; + }); + }, + + parseOps: function(arg) { + var opts; + if (arg.jquery) { + opts = { + $nav: arg + }; + } else { + opts = arg; + } + opts.$scope = opts.$scope || $(document.body); + return opts; + } + }, + + // accepts a jQuery object, or an options object + init: function(opts) { + opts = this.helpers.parseOps(opts); + + // ensure that the data attribute is in place for styling + opts.$nav.attr('data-toggle', 'toc'); + + var $topContext = this.helpers.createChildNavList(opts.$nav); + var topLevel = this.helpers.getTopLevel(opts.$scope); + var $headings = this.helpers.getHeadings(opts.$scope, topLevel); + this.helpers.populateNav($topContext, topLevel, $headings); + } + }; + + $(function() { + $('nav[data-toggle="toc"]').each(function(i, el) { + var $nav = $(el); + Toc.init($nav); + }); + }); +})(); diff --git a/docs/docsearch.css b/docs/docsearch.css new file mode 100644 index 0000000..e5f1fe1 --- /dev/null +++ b/docs/docsearch.css @@ -0,0 +1,148 @@ +/* Docsearch -------------------------------------------------------------- */ +/* + Source: https://github.com/algolia/docsearch/ + License: MIT +*/ + +.algolia-autocomplete { + display: block; + -webkit-box-flex: 1; + -ms-flex: 1; + flex: 1 +} + +.algolia-autocomplete .ds-dropdown-menu { + width: 100%; + min-width: none; + max-width: none; + padding: .75rem 0; + background-color: #fff; + background-clip: padding-box; + border: 1px solid rgba(0, 0, 0, .1); + box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175); +} + +@media (min-width:768px) { + .algolia-autocomplete .ds-dropdown-menu { + width: 175% + } +} + +.algolia-autocomplete .ds-dropdown-menu::before { + display: none +} + +.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] { + padding: 0; + background-color: rgb(255,255,255); + border: 0; + max-height: 80vh; +} + +.algolia-autocomplete .ds-dropdown-menu .ds-suggestions { + margin-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion { + padding: 0; + overflow: visible +} + +.algolia-autocomplete .algolia-docsearch-suggestion--category-header { + padding: .125rem 1rem; + margin-top: 0; + font-size: 1.3em; + font-weight: 500; + color: #00008B; + border-bottom: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--wrapper { + float: none; + padding-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column { + float: none; + width: auto; + padding: 0; + text-align: left +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content { + float: none; + width: auto; + padding: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content::before { + display: none +} + +.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header { + padding-top: .75rem; + margin-top: .75rem; + border-top: 1px solid rgba(0, 0, 0, .1) +} + +.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column { + display: block; + padding: .1rem 1rem; + margin-bottom: 0.1; + font-size: 1.0em; + font-weight: 400 + /* display: none */ +} + +.algolia-autocomplete .algolia-docsearch-suggestion--title { + display: block; + padding: .25rem 1rem; + margin-bottom: 0; + font-size: 0.9em; + font-weight: 400 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--text { + padding: 0 1rem .5rem; + margin-top: -.25rem; + font-size: 0.8em; + font-weight: 400; + line-height: 1.25 +} + +.algolia-autocomplete .algolia-docsearch-footer { + width: 110px; + height: 20px; + z-index: 3; + margin-top: 10.66667px; + float: right; + font-size: 0; + line-height: 0; +} + +.algolia-autocomplete .algolia-docsearch-footer--logo { + background-image: url("data:image/svg+xml;utf8,"); + background-repeat: no-repeat; + background-position: 50%; + background-size: 100%; + overflow: hidden; + text-indent: -9000px; + width: 100%; + height: 100%; + display: block; + transform: translate(-8px); +} + +.algolia-autocomplete .algolia-docsearch-suggestion--highlight { + color: #FF8C00; + background: rgba(232, 189, 54, 0.1) +} + + +.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight { + box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5) +} + +.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content { + background-color: rgba(192, 192, 192, .15) +} diff --git a/docs/docsearch.js b/docs/docsearch.js new file mode 100644 index 0000000..b35504c --- /dev/null +++ b/docs/docsearch.js @@ -0,0 +1,85 @@ +$(function() { + + // register a handler to move the focus to the search bar + // upon pressing shift + "/" (i.e. "?") + $(document).on('keydown', function(e) { + if (e.shiftKey && e.keyCode == 191) { + e.preventDefault(); + $("#search-input").focus(); + } + }); + + $(document).ready(function() { + // do keyword highlighting + /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */ + var mark = function() { + + var referrer = document.URL ; + var paramKey = "q" ; + + if (referrer.indexOf("?") !== -1) { + var qs = referrer.substr(referrer.indexOf('?') + 1); + var qs_noanchor = qs.split('#')[0]; + var qsa = qs_noanchor.split('&'); + var keyword = ""; + + for (var i = 0; i < qsa.length; i++) { + var currentParam = qsa[i].split('='); + + if (currentParam.length !== 2) { + continue; + } + + if (currentParam[0] == paramKey) { + keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20")); + } + } + + if (keyword !== "") { + $(".contents").unmark({ + done: function() { + $(".contents").mark(keyword); + } + }); + } + } + }; + + mark(); + }); +}); + +/* Search term highlighting ------------------------------*/ + +function matchedWords(hit) { + var words = []; + + var hierarchy = hit._highlightResult.hierarchy; + // loop to fetch from lvl0, lvl1, etc. + for (var idx in hierarchy) { + words = words.concat(hierarchy[idx].matchedWords); + } + + var content = hit._highlightResult.content; + if (content) { + words = words.concat(content.matchedWords); + } + + // return unique words + var words_uniq = [...new Set(words)]; + return words_uniq; +} + +function updateHitURL(hit) { + + var words = matchedWords(hit); + var url = ""; + + if (hit.anchor) { + url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor; + } else { + url = hit.url + '?q=' + escape(words.join(" ")); + } + + return url; +} diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..ccc7d3d --- /dev/null +++ b/docs/index.html @@ -0,0 +1,236 @@ + + + + + + + +An R Plug-in for the Distributed Hydrological Model GEOtop • geotopbricks + + + + + + + + + + + + +
    +
    + + + + +
    +
    + + +
    + +

    R plug-in Development of CRAN R package geotopbricks (http://cran.r-project.org/web/packages/geotopbricks)

    +

    To install this package on R fram R console:

    +

    ```{r}

    +
    +

    library(devtools)

    +
    +
    +

    library(reotes)

    +
    +
    +

    install_github(“ecor/geotopbricks”)

    +
    +
    <img src="inst/sticker/sticker_geotopbricks_v1.png"  width="400"/>
    +<img src="inst/sticker/sticker_geotopbricks_v2_.png"  width="400"/>
    +
    +<!--![image](inst/sticker/sticker_geotopbricks_v2_.png)
    +![image](inst/sticker/sticker_geotopbricks_v1.png) -->
    +
    +
    +
    +## Getting Started
    +
    +Try to run the following lines of code. More material also on https://github.com/ecor/geotopbricks_doc  .
    +
    +
    +
    +
    +```{r}
    +library(geotopbricks)
    +
    +#Simulation working path
    +
    +
    +
    +wpath <-  'https://raw.githubusercontent.com/ecor/geotopbricks_doc/master/simulations/panola13_run2xC_test3'
    +## wpath (RAW VERSION) of https://github.com/ecor/geotopbricks_doc/tree/master/simulations/panola13_run2xC_test3
    +prefix <- get.geotop.inpts.keyword.value("SoilLiqWaterPressTensorFile",wpath=wpath)
    +
    +slope <- get.geotop.inpts.keyword.value("SlopeMapFile",raster=TRUE,wpath=wpath)
    +bedrock_depth <- get.geotop.inpts.keyword.value("BedrockDepthMapFile",raster=TRUE,wpath=wpath)
    +
    +layers <- get.geotop.inpts.keyword.value("SoilLayerThicknesses",numeric=TRUE,wpath=wpath)
    +names(layers) <- paste("L",1:length(layers),sep="")
    +
    +##### set van genuchten parameters to estimate water volume
    +theta_sat <- get.geotop.inpts.keyword.value("ThetaSat",numeric=TRUE,wpath=wpath)
    +theta_res <- get.geotop.inpts.keyword.value("ThetaRes",numeric=TRUE,wpath=wpath)
    +alphaVG <-  get.geotop.inpts.keyword.value("AlphaVanGenuchten",
    +                                           numeric=TRUE,wpath=wpath) # expressed in mm^-1
    +
    +nVG <-  get.geotop.inpts.keyword.value("NVanGenuchten",numeric=TRUE,wpath=wpath)
    +
    +
    +##### end set van genuchten parameters to estimate water volume
    +
    +
    +##### set meteo data
    +
    +
    +tz <- "Etc/GMT-1"  ## See help(timezones) In particular:
    +## Most platforms support time zones of the form Etc/GMT+n and Etc/GMT-n (possibly also without prefix Etc/),
    +## which assume a fixed offset from UTC (hence no DST). Contrary to some expectations
    +## (but consistent with names such as PST8PDT), negative offsets are times ahead of (east of) UTC,
    +## positive offsets are times behind (west of) UTC.
    +start <-  get.geotop.inpts.keyword.value("InitDateDDMMYYYYhhmm",date=TRUE,wpath=wpath,tz=tz)
    +end <- get.geotop.inpts.keyword.value("EndDateDDMMYYYYhhmm",date=TRUE,wpath=wpath,tz=tz)
    +
    +nmeteo <- get.geotop.inpts.keyword.value("NumberOfMeteoStations",numeric=TRUE,wpath=wpath)
    +level <- 1:nmeteo
    +
    +## set meteo data
    +
    +meteo <- get.geotop.inpts.keyword.value("MeteoFile",wpath=wpath,data.frame=TRUE,
    +                                        level=level,start_date=start,end_date=end,tz=tz)
    +
    +##### end set meteo data
    +
    +## IMPORTING AN OUTPUT SOIL MOISTURE PROFILE:
    +
    +
    +wpath <-  'https://raw.githubusercontent.com/ecor/geotopbricks_doc/master/simulations/Muntatschini_pnt_1_225_B2_004'
    +## wpath (RAW VERSION) of https://github.com/ecor/geotopbricks_doc/tree/master/simulations/Muntatschini_pnt_1_225_B2_004
    +## Not run:
    +SMC  <- get.geotop.inpts.keyword.value("SoilLiqContentProfileFile",
    +                                       wpath=wpath,data.frame=TRUE,date_field="Date12.DDMMYYYYhhmm.",
    +                                       formatter="%04d")
    +
    +SMCz  <- get.geotop.inpts.keyword.value("SoilLiqContentProfileFile",
    +                                        wpath=wpath,data.frame=TRUE,date_field="Date12.DDMMYYYYhhmm.",
    +                                        formatter="%04d",zlayer.formatter="z%04d")
    +
    +## End(Not run)
    +
    +
    +
    +
    +

    Further Presentations +

    +

    Repository containing source code / scripts of conference documentiation and presentations: https://github.com/ecor/geotopbricks_doc

    +

    UseR 2019, July 10, Toulouse,France presentation’s video: https://www.youtube.com/watch?v=sKMCyoOnpf8

    +
    +
    + +
    + + +
    + + +
    + +
    +

    +

    Site built with pkgdown 2.1.0.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 0000000..88ad827 --- /dev/null +++ b/docs/link.svg @@ -0,0 +1,12 @@ + + + + + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 0000000..80ea5b8 --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,384 @@ +/* Sticky footer */ + +/** + * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/ + * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css + * + * .Site -> body > .container + * .Site-content -> body > .container .row + * .footer -> footer + * + * Key idea seems to be to ensure that .container and __all its parents__ + * have height set to 100% + * + */ + +html, body { + height: 100%; +} + +body { + position: relative; +} + +body > .container { + display: flex; + height: 100%; + flex-direction: column; +} + +body > .container .row { + flex: 1 0 auto; +} + +footer { + margin-top: 45px; + padding: 35px 0 36px; + border-top: 1px solid #e5e5e5; + color: #666; + display: flex; + flex-shrink: 0; +} +footer p { + margin-bottom: 0; +} +footer div { + flex: 1; +} +footer .pkgdown { + text-align: right; +} +footer p { + margin-bottom: 0; +} + +img.icon { + float: right; +} + +/* Ensure in-page images don't run outside their container */ +.contents img { + max-width: 100%; + height: auto; +} + +/* Fix bug in bootstrap (only seen in firefox) */ +summary { + display: list-item; +} + +/* Typographic tweaking ---------------------------------*/ + +.contents .page-header { + margin-top: calc(-60px + 1em); +} + +dd { + margin-left: 3em; +} + +/* Section anchors ---------------------------------*/ + +a.anchor { + display: none; + margin-left: 5px; + width: 20px; + height: 20px; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; +} + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -40px; +} + +/* Navbar submenu --------------------------*/ + +.dropdown-submenu { + position: relative; +} + +.dropdown-submenu>.dropdown-menu { + top: 0; + left: 100%; + margin-top: -6px; + margin-left: -1px; + border-radius: 0 6px 6px 6px; +} + +.dropdown-submenu:hover>.dropdown-menu { + display: block; +} + +.dropdown-submenu>a:after { + display: block; + content: " "; + float: right; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; + border-width: 5px 0 5px 5px; + border-left-color: #cccccc; + margin-top: 5px; + margin-right: -10px; +} + +.dropdown-submenu:hover>a:after { + border-left-color: #ffffff; +} + +.dropdown-submenu.pull-left { + float: none; +} + +.dropdown-submenu.pull-left>.dropdown-menu { + left: -100%; + margin-left: 10px; + border-radius: 6px 0 6px 6px; +} + +/* Sidebar --------------------------*/ + +#pkgdown-sidebar { + margin-top: 30px; + position: -webkit-sticky; + position: sticky; + top: 70px; +} + +#pkgdown-sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#pkgdown-sidebar h2:first-child { + margin-top: 0; +} + +#pkgdown-sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +/* bootstrap-toc tweaks ------------------------------------------------------*/ + +/* All levels of nav */ + +nav[data-toggle='toc'] .nav > li > a { + padding: 4px 20px 4px 6px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; +} + +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 5px; + color: inherit; + border-left: 1px solid #878787; +} + +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 5px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; + border-left: 2px solid #878787; +} + +/* Nav: second level (shown on .active) */ + +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} + +nav[data-toggle='toc'] .nav .nav > li > a { + padding-left: 16px; + font-size: 1.35rem; +} + +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 15px; +} + +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 15px; + font-weight: 500; + font-size: 1.35rem; +} + +/* orcid ------------------------------------------------------------------- */ + +.orcid { + font-size: 16px; + color: #A6CE39; + /* margins are required by official ORCID trademark and display guidelines */ + margin-left:4px; + margin-right:4px; + vertical-align: middle; +} + +/* Reference index & topics ----------------------------------------------- */ + +.ref-index th {font-weight: normal;} + +.ref-index td {vertical-align: top; min-width: 100px} +.ref-index .icon {width: 40px;} +.ref-index .alias {width: 40%;} +.ref-index-icons .alias {width: calc(40% - 40px);} +.ref-index .title {width: 60%;} + +.ref-arguments th {text-align: right; padding-right: 10px;} +.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +pre, code, pre code { + background-color: #f8f8f8; + color: #333; +} +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} + +pre { + border: 1px solid #eee; +} + +pre .img, pre .r-plt { + margin: 5px 0; +} + +pre .img img, pre .r-plt img { + background-color: #fff; +} + +code a, pre a { + color: #375f84; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #000000;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ + +.error {font-weight: bolder;} +.warning {font-weight: bolder;} + +/* Clipboard --------------------------*/ + +.hasCopyButton { + position: relative; +} + +.btn-copy-ex { + position: absolute; + right: 0; + top: 0; + visibility: hidden; +} + +.hasCopyButton:hover button.btn-copy-ex { + visibility: visible; +} + +/* headroom.js ------------------------ */ + +.headroom { + will-change: transform; + transition: transform 200ms linear; +} +.headroom--pinned { + transform: translateY(0%); +} +.headroom--unpinned { + transform: translateY(-100%); +} + +/* mark.js ----------------------------*/ + +mark { + background-color: rgba(255, 255, 51, 0.5); + border-bottom: 2px solid rgba(255, 153, 51, 0.3); + padding: 1px; +} + +/* vertical spacing after htmlwidgets */ +.html-widget { + margin-bottom: 10px; +} + +/* fontawesome ------------------------ */ + +.fab { + font-family: "Font Awesome 5 Brands" !important; +} + +/* don't display links in code chunks when printing */ +/* source: https://stackoverflow.com/a/10781533 */ +@media print { + code a:link:after, code a:visited:after { + content: ""; + } +} + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 0000000..6f0eee4 --- /dev/null +++ b/docs/pkgdown.js @@ -0,0 +1,108 @@ +/* http://gregfranko.com/blog/jquery-best-practices/ */ +(function($) { + $(function() { + + $('.navbar-fixed-top').headroom(); + + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); + }); + + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } + } + + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); + + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } + + /* Clipboard --------------------------*/ + + function changeTooltipMessage(element, msg) { + var tooltipOriginalTitle=element.getAttribute('data-original-title'); + element.setAttribute('data-original-title', msg); + $(element).tooltip('show'); + element.setAttribute('data-original-title', tooltipOriginalTitle); + } + + if(ClipboardJS.isSupported()) { + $(document).ready(function() { + var copyButton = ""; + + $("div.sourceCode").addClass("hasCopyButton"); + + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); + + // Initialize tooltips: + $('.btn-copy-ex').tooltip({container: 'body'}); + + // Initialize clipboard: + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { + text: function(trigger) { + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); + } + }); + + clipboardBtnCopies.on('success', function(e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); + + clipboardBtnCopies.on('error', function() { + changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); + }); + }); + } +})(window.jQuery || window.$) diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml new file mode 100644 index 0000000..fce1f30 --- /dev/null +++ b/docs/pkgdown.yml @@ -0,0 +1,5 @@ +pandoc: 3.1.1 +pkgdown: 2.1.0 +pkgdown_sha: ~ +articles: {} +last_built: 2024-08-13T06:13Z diff --git a/docs/reference/GeotopRasterBrick-class.html b/docs/reference/GeotopRasterBrick-class.html new file mode 100644 index 0000000..4d2d124 --- /dev/null +++ b/docs/reference/GeotopRasterBrick-class.html @@ -0,0 +1,121 @@ + +GeotopRasterBrick-class — GeotopRasterBrick-class • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    A GeotopRasterBrick: an object to manage raster maps provied by GEOtop!!

    +
    + + +
    +

    Details

    + +
    ascpath:
    +

    A "zoo" S3 object containing the names of ascii maps provided by GEOtop

    +

    + +
    index:
    +

    A "POSIXt" S3 object containing time or dates on which raster layers of brick are referred

    +

    + +
    layer:
    +

    character. Name of the vertical layer at which raster map are referred

    +

    + +
    brick:
    +

    A "RasterBrick-class" S4 object containing the Raster-Layer maps imported from GEOtop output files

    +

    + + +

    #' @note A GeotopRasterBrick object can be created by new("GeotopRasterBrick", ...)

    +
    +
    +

    See also

    +

    Raster-class

    +
    +
    +

    Author

    +

    Emanuele Cordano

    +
    + +
    +

    Examples

    +
    showClass("GeotopRasterBrick")
    +#> Class "GeotopRasterBrick" [package "geotopbricks"]
    +#> 
    +#> Slots:
    +#>                                                       
    +#> Name:      ascpath       index       layer       brick
    +#> Class:         zoo      POSIXt   character RasterBrick
    +
    +
    + 
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/KML-methods.html b/docs/reference/KML-methods.html new file mode 100644 index 0000000..ca8524b --- /dev/null +++ b/docs/reference/KML-methods.html @@ -0,0 +1,123 @@ + +KML — KML • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    KML method for a GeotopRasterBrick object

    +
    + +
    +
    # S4 method for class 'GeotopRasterBrick'
    +KML(
    +  x,
    +  filename,
    +  crs = as.character("+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs"),
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    the GeotopRasterBrick object

    + + +
    filename
    +

    mane of the KML file to produce

    + + +
    crs
    +

    character string containing the LatLon reference system. Default is "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs" (see https://spatialreference.org/ref/epsg/4326/).

    + + +
    ...
    +

    further argument for S4 method KLM for Raster object.

    + +
    +
    +

    Note

    +

    A coordinate transformation is made with projectRaster.

    +
    + +
    +

    Examples

    +
    
    +
    +library(geotopbricks)
    +# The examples is the following R script contained in a 'inst' directory of the package source
    +f <- system.file("doc/examples/example.KML.GeotopRasterBrick.R",package="geotopbricks")
    +if (FALSE) { # \dontrun{
    +  source(f) # Uncomment this line to run the example. 
    +} # } 
    +# You can copy the example file using file.copy(from=f,to=....,...) See file.copy documentation
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/Ops-methods.html b/docs/reference/Ops-methods.html new file mode 100644 index 0000000..34b0c4c --- /dev/null +++ b/docs/reference/Ops-methods.html @@ -0,0 +1,103 @@ + +Ops — Ops • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Ops

    +
    + +
    +
    # S4 method for class 'GeotopRasterBrick,GeotopRasterBrick'
    +Ops(e1, e2)
    +
    +# S4 method for class 'GeotopRasterBrick,numeric'
    +Ops(e1, e2)
    +
    +# S4 method for class 'numeric,GeotopRasterBrick'
    +Ops(e1, e2)
    +
    + +
    +

    Arguments

    + + +
    e1, e2
    +

    the GeotopRasterBrick or numeric objects

    + +
    +
    +

    Details

    +

    Ops method for a GeotopRasterBrick object

    +
    +
    +

    Note

    +

    If e1 or e2 time index is not taken into account.

    +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png new file mode 100644 index 0000000..17a3580 Binary files /dev/null and b/docs/reference/Rplot001.png differ diff --git a/docs/reference/argsParser.html b/docs/reference/argsParser.html new file mode 100644 index 0000000..911edab --- /dev/null +++ b/docs/reference/argsParser.html @@ -0,0 +1,119 @@ + +Parser of an argument string — argsParser • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    This command parses ...DESCRITION TO DO !!!

    +
    + +
    +
    argsParser(option, args, sep = " ", novalue_response = NULL)
    +
    + +
    +

    Arguments

    + + +
    option
    +

    character strings containg options (or flag) whose values

    + + +
    args
    +

    String containing all the arguments of an R script

    + + +
    sep
    +

    separator character. Default is " ". If it is of length 2, the first is seperator among different options, the second is betwwen option name and its value.

    + + +
    novalue_response
    +

    value used in case the option is missing. Default is NULL.

    + +
    + +
    +

    Examples

    +
    
    +args <- "--value  6  --fruit apple"
    +
    +option <- "--fruit"
    +
    +value <- argsParser(option=option,args=args)
    +
    +option2 <- "--jobs"
    +
    +value2 <- argsParser(option=option2,args=args)
    +value22 <- argsParser(option=option2,args=args,novalue_response="./")
    + args_b <- "value=6 , fruit=apple"
    +option3 <- "value"
    +value <- argsParser(option=option3,args=args_b,sep=c(",","="))
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/bondone.html b/docs/reference/bondone.html new file mode 100644 index 0000000..7b13817 --- /dev/null +++ b/docs/reference/bondone.html @@ -0,0 +1,147 @@ + +Bondone Dataset — bondone • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    It contains hourly meteorological data observed at MeteoTrentino T0327 station located at Monte Bondone-Viotte (Trentino, Easter Alps, Italy) from August 2004 to December 2012.\

    +

    The zoo object 'meteo' contains:

    Iprec
    +

    Hourly Precipitation Depth expressed in millimeters

    + + +
    AirT
    +

    Air Temperature expressed in Celsius Degree

    + + +
    RH
    +

    Relative Humidity in PerCent

    + + +
    WinDir
    +

    Wind Direction expressed in Degrees North Clockwise

    + + +
    WinSp
    +

    Wind Direction expressed in meters per second

    + + +
    Swglob
    +

    Short-Wave Radiation expressed in Watts per square meters

    + + +

    The corresponding time axis vector for each observation can be printed by typing index(meteo).

    +
    + +
    +
    data(bondone)
    +
    + +
    +

    Details

    +

    This data set stores all meteorological information useful for a GEOtop simulation. +The user can easily use the package with his/her own data after replacing the values of such variables.

    +
    +
    +

    Format

    +

    Data frame , 'zoo' object

    +
    +
    +

    Source

    +

    Original data are provided by Provincia Autonoma di Trento (https://www.meteotrentino.it/)).

    +

    This dataset is intended for research purposes only, being distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

    +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/brick-methods.html b/docs/reference/brick-methods.html new file mode 100644 index 0000000..c0acd8c --- /dev/null +++ b/docs/reference/brick-methods.html @@ -0,0 +1,142 @@ + +brick — brick • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Added implemetation for 'brick' S4 method

    +

    @title brick

    +
    + +
    +
    # S4 method for class 'zoo'
    +brick(
    +  x,
    +  layer = 1,
    +  timerange = NULL,
    +  time = NULL,
    +  rows = 1:nrow(x),
    +  crs = NULL,
    +  use.read.raster.from.url = TRUE
    +)
    +
    +# S4 method for class 'GeotopRasterBrick'
    +brick(x)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    a 'zoo' object returned by function pointer.to.maps.xyz.time or pointer.to.maps.xy.time +or a GeotopRasterBrick-class object

    + + +
    layer
    +

    layer at which raster maps are imported. If is NULL, maps ara no-zlayer distributed and zoo must be returend by pointer.to.maps.xy.time

    + + +
    timerange
    +

    two-elememts vector containing the time range at which geotop maps are imported

    + + +
    time
    +

    vector of time instants at which geotop maps are imported

    + + +
    rows
    +

    rows of zoo correspondig to the geotop maps that are imported. By default all rows of zoo are considered. It is calculated by time or timerange if they are not set as NULL.

    + + +
    crs
    +

    coordinate system see RasterBrick-class

    + + +
    use.read.raster.from.url
    +

    logical value. Default is TRUE. If TRUE the RasterLayer are read with read.raster.from.url, istead of raster (otherwise). It is recomended in case the files whose paths are contained in x are remote and are 'http' addresses. In this cases the stand-alone method raster(x) does not always work and use.read.raster.from.url is necessary.

    + +
    +
    +

    Value

    +

    a RasterBrick-class containing the geopop maps indicated by x, which is already in a GeotopRasterBrick-class object or a 'zoo' object returned by function pointer.to.maps.xyz.time or pointer.to.maps.xy.time.

    +
    + + +
    +

    Examples

    +
    # TON TOSS 
    +# See the examples in the functions listed in the 'SeeAlso' section
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/brick.decimal.formatter.html b/docs/reference/brick.decimal.formatter.html new file mode 100644 index 0000000..185611c --- /dev/null +++ b/docs/reference/brick.decimal.formatter.html @@ -0,0 +1,149 @@ + +Imports a brick of raster ascii maps into a 'brick' object — brick.decimal.formatter • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Imports a brick of raster ascii maps into a 'brick' object

    +
    + +
    +
    brick.decimal.formatter(
    +  file = NULL,
    +  file_prefix,
    +  formatter = "%04d",
    +  file_extension = ".asc",
    +  nlayers = 10,
    +  use.read.raster.from.url = FALSE,
    +  crs = NULL,
    +  start.from.zero = FALSE
    +)
    +
    + +
    +

    Arguments

    + + +
    file
    +

    fileneme of the 'brick' files containing the decimal formatter. It is NULL by default, otherwise it replaces file_suffix, formatter and file_extension.

    + + +
    file_prefix
    +

    character string suffix name of the 'brick' files.

    + + +
    formatter
    +

    string value. Default is "%04d" .

    + + +
    file_extension
    +

    strinf value. Default is ".asc"

    + + +
    nlayers
    +

    number of layers

    + + +
    use.read.raster.from.url
    +

    logical value. Default is FALSE. (this is recommended in this function). If TRUE the RasterLayer are read with read.raster.from.url, istead of raster (otherwise). It is recomended in case the files whose paths are contained in x are remote and are 'http' addresses. In this cases the stand-alone method raster(x) does not always work and use.read.raster.from.url is necessary.

    + + +
    crs
    +

    coordinate system see RasterBrick-class,brick, Default is NULL.

    + + +
    start.from.zero
    +

    logical value. Default is FALSE. If TRUE the formatter starts from 0000, otherwise it starts from 0001.

    + +
    +
    +

    Value

    +

    the output is returned as a RasterBrick-class object

    +
    + +
    +

    Examples

    +
    library(geotopbricks)
    +library(raster)
    +file <- system.file("example_files/examples/snowthickness",package="geotopbricks")
    +file <- paste(file,"SnowThickness0000L%04d.asc",sep="/")
    +# nlayers=15
    +nlayers <- 6 ## Only 6 layers are read to minimize the elapsed time of the example!!
    +b <- brick.decimal.formatter(file=file,nlayers=nlayers)
    +nlayers(b)
    +#> [1] 6
    +names(b)
    +#> [1] "X.tmp.RtmpnGzYTO.temp_libpath30e06e28ea68a9.geotopbricks.example_files.examples.snowthickness.SnowThickness0000L0001.asc"
    +#> [2] "X.tmp.RtmpnGzYTO.temp_libpath30e06e28ea68a9.geotopbricks.example_files.examples.snowthickness.SnowThickness0000L0002.asc"
    +#> [3] "X.tmp.RtmpnGzYTO.temp_libpath30e06e28ea68a9.geotopbricks.example_files.examples.snowthickness.SnowThickness0000L0003.asc"
    +#> [4] "X.tmp.RtmpnGzYTO.temp_libpath30e06e28ea68a9.geotopbricks.example_files.examples.snowthickness.SnowThickness0000L0004.asc"
    +#> [5] "X.tmp.RtmpnGzYTO.temp_libpath30e06e28ea68a9.geotopbricks.example_files.examples.snowthickness.SnowThickness0000L0005.asc"
    +#> [6] "X.tmp.RtmpnGzYTO.temp_libpath30e06e28ea68a9.geotopbricks.example_files.examples.snowthickness.SnowThickness0000L0006.asc"
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/brickFromOutputSoil3DTensor.html b/docs/reference/brickFromOutputSoil3DTensor.html new file mode 100644 index 0000000..6e35c3e --- /dev/null +++ b/docs/reference/brickFromOutputSoil3DTensor.html @@ -0,0 +1,254 @@ + +brickFromOutputSoil3DTensor — brickFromOutputSoil3DTensor • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Extracts a brick or a raster layer from a output 3D Tensor or 2D map respectively

    +
    + +
    +
    brickFromOutputSoil3DTensor(
    +  x,
    +  when,
    +  layers = "SoilLayerThicknesses",
    +  one.layer = FALSE,
    +  suffix = "L%04dN%04d.asc",
    +  time_formatter = "N%04d",
    +  suffix_one.layer = "N%04d.asc",
    +  wpath = NULL,
    +  tz = "A",
    +  start_date_key = "InitDateDDMMYYYYhhmm",
    +  end_date_key = "EndDateDDMMYYYYhhmm",
    +  timestep = "OutputSoilMaps",
    +  use.read.raster.from.url = FALSE,
    +  crs = NULL,
    +  projfile = "geotop.proj",
    +  start.from.zero = FALSE,
    +  secondary.suffix = NULL,
    +  only.map.filename = FALSE,
    +  add_suffix_dir = NULL,
    +  ...
    +)
    +
    +rasterFromOutput2DMap(x, when, ...)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    string. GEOtop keyword reletated to the 3D or 2D variable to be imported in R.

    + + +
    when
    +

    POSIXct-class for date and time on which the variable x is requested.

    + + +
    layers
    +

    number of soil layer or geotop keyword for soil layer (e.g. SoilLayerThicknesses or SoilFile). Default is SoilLayerThicknesses.

    + + +
    one.layer
    +

    logical value. If TRUE a RasterLayer-class object is imported, otherwise a RasterBrick-classobject is returened. Default for brickFromOutputSoil3DTensor is FALSE

    + + +
    suffix
    +

    charachter string containing the decimal formatter used by GEOtop in the output file names. Default is "L%04dN%04.asc". A simple user is recommended not to modify the value of this argument and use the default value.

    + + +
    time_formatter, suffix_one.layer
    +

    charachter string (suffix_one.layer is used for 2Dxy map) containing the decimal formatter used by GEOtop in the output file names to indicate time instant. Default is "N%04.asc". A simple user is recommended not to modify the value of this argument and use the default value.

    + + +
    wpath, tz, use.read.raster.from.url
    +

    see get.geotop.inpts.keyword.value

    + + +
    start_date_key, end_date_key
    +

    initial and final detes and times of the GEOtop simulation or alternatively the respective keywords of *.inpts file (Default)

    + + +
    timestep
    +

    time step expressed in seconds every which the raster file has been created. It can be a string corresponding to the geotop keyword in the inpts file. Default value is "OutputSoilMaps".

    + + +
    crs, start.from.zero
    +

    see brick.decimal.formatter. If crs is not NULL (Default) , projfile is ignored.

    + + +
    projfile
    +

    name of the *.proj file containing CRS information. See get.geotop.inpts.keyword.value. Default is "geotop.proj". If is NULL or NA or this file does not exist, it is not searched and read.. In case use.read.raster.from.url is TRUE and no NULL or NA values are assinged, the *.proj file is searched.

    + + +
    secondary.suffix
    +

    String secondary suffix which can be added at the end of the Map file name (optional). Default is NULL and no secondary suffix is added.

    + + +
    only.map.filename
    +

    logical value. If it is TRUE, only map file names are returned and maps are not imported. Default is FALSE.

    + + +
    add_suffix_dir, ...
    +

    additional arguments for get.geotop.inpts.keyword.value or brickFromOutputSoil3DTensor

    + +
    +
    +

    Details

    +

    These functions brickFromOutputSoil3DTensor and rasterFromOutput2DMap return 3D or 2D Raster-class objects respectively. rasterFromOutput2DMap is a wrapper function of brickFromOutputSoil3DTensor with the option one.layer==TRUE. +The functionswork with the following output keywords:

    +

    "SoilTempTensorFile",

    +

    "SoilAveragedTempTensorFile",

    +

    "SoilLiqContentTensorFile",

    +

    "SoilAveragedLiqContentTensorFile",

    +

    "SoilIceContentTensorFile",

    +

    "SoilAveragedIceContentTensorFile",

    +

    "SoilLiqWaterPressTensorFile",

    +

    "SoilTotWaterPressTensorFile" for brickFromOutputSoil3DTensor;

    + +

    "FirstSoilLayerTempMapFile",

    +

    "FirstSoilLayerAveragedTempMapFile",

    +

    "FirstSoilLayerLiqContentMapFile",

    +

    "FirstSoilLayerIceContentMapFile",

    +

    "LandSurfaceWaterDepthMapFile",

    +

    "ChannelSurfaceWaterDepthMapFile",

    +

    "NetRadiationMapFile",

    +

    "InLongwaveRadiationMapFile",

    +

    "NetLongwaveRadiationMapFile",

    +

    "NetShortwaveRadiationMapFile",

    +

    "InShortwaveRadiationMapFile",

    +

    "DirectInShortwaveRadiationMapFile",

    + +

    "ShadowFractionTimeMapFile",

    +

    "SurfaceHeatFluxMapFile",

    +

    "SurfaceSensibleHeatFluxMapFile",

    +

    "SurfaceLatentHeatFluxMapFile",

    +

    "SurfaceTempMapFile",

    +

    "PrecipitationMapFile",

    +

    "CanopyInterceptedWaterMapFile",

    +

    "SnowDepthMapFile",

    +

    "GlacierDepthMapFile",

    +

    "SnowMeltedMapFile",

    +

    "SnowSublMapFile",

    +

    "GlacierMeltedMapFile",

    +

    "GlacierSublimatedMapFile",

    +

    "AirTempMapFile",

    +

    "WindSpeedMapFile",

    +

    "WindDirMapFile",

    +

    "RelHumMapFiladd_suffix_dir=NULLe",

    +

    "SWEMapFile",

    +

    "GlacierWaterEqMapFile"

    +

    "SnowDurationMapFile",

    +

    "ThawedSoilDepthMapFile",

    +

    "ThawedSoilDepthFromAboveMapFile",

    +

    "WaterTableDepthMapFile",

    +

    "WaterTableDepthFromAboveMapFile",

    +

    "NetPrecipitationMapFile",

    +

    "EvapotranspirationFromSoilMapFile" for rasterFromOutput2DMap.

    +
    + +
    +

    Author

    +

    Emanuele Cordano

    +
    + +
    +

    Examples

    +
    
    +library(geotopbricks)
    +if (FALSE) { # \dontrun{
    +# The data containing in the link are only for educational use
    +wpath <- 'https://raw.githubusercontent.com/ecor/geotopbricks_doc/master/simulations/idroclim_test1'
    +## URL path (RAW VERSION) of 
    +## https://github.com/ecor/geotopbricks_doc/tree/master/simulations/idroclim_test1
    +x <- "SoilLiqContentTensorFile"
    +tz <-  "Etc/GMT-1"
    +when <- as.POSIXct("2002-03-22",tz=tz)
    +
    +# Not Run because it elapses too long time!!! 
    +# Please Uncomment the following lines to run by yourself!!!
    + b <- brickFromOutputSoil3DTensor(x,when=when,wpath=wpath,tz=tz,use.read.raster.from.url=TRUE)
    +
    +# a 2D map: 
    +x_e <- "SnowDepthMapFile"
    +# Not Run: uncomment the following line
    +
    +m <- rasterFromOutput2DMap(x_e,when=when,wpath=wpath,timestep="OutputSnowMaps",
    +                            tz=tz,use.read.raster.from.url=TRUE)
    +## NOTE: set use.read.raster.from.url=FALSE (default) 
    +# if the "wpath" directorty is in the local file system.
    +# Not Run: uncomment the following line
    +plot(m)
    +} # }
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/create.geotop.inpts.keyword.html b/docs/reference/create.geotop.inpts.keyword.html new file mode 100644 index 0000000..b6d4cd5 --- /dev/null +++ b/docs/reference/create.geotop.inpts.keyword.html @@ -0,0 +1,142 @@ + +Creates an 'geotop.inpts' files the keyword and their values of a date.frame like the one returned by declared.geotop.inpts.keywords — create.geotop.inpts.keyword • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Creates an 'geotop.inpts' files the keyword and their values of a date.frame like the one returned by declared.geotop.inpts.keywords

    +
    + +
    +
    create.geotop.inpts.keyword(
    +  df,
    +  file = "geotop.inpts.copy",
    +  wpath = NULL,
    +  comment.lines = "default",
    +  header = "default",
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    df
    +

    data frame returend by declared.geotop.inpts.keywords

    + + +
    file
    +

    connetion or file name where to write 'df'

    + + +
    wpath
    +

    complere path to file (optional). Default is NULL.

    + + +
    comment.lines
    +

    string or vector of strings to add as comments for each keyword. If it is NULL the comment lines are omitted.

    + + +
    header
    +

    string or vector of strings to add as a header. If it is NULL the header is omitted.

    + + +
    ...
    +

    further arguments for writeLines

    + +
    +
    +

    Details

    +

    In case comment.lines and header are set equal to "default", +they are suitably modified within the function code. +See the example output.

    +
    + + +
    +

    Examples

    +
    
    +library(geotopbricks)
    +if (FALSE) { # \dontrun{
    +#Simulation working path
    +wpath <- 
    +'https://raw.githubusercontent.com/ecor/geotopbricks_doc/master/simulations/panola13_run2xC_test3'
    +## URL path (RAW VERSION) of 
    +## https://github.com/ecor/geotopbricks_doc/tree/master/simulations/panola13_run2xC_test3
    +df <- declared.geotop.inpts.keywords(wpath=wpath)
    +create.geotop.inpts.keyword(df=df)
    +} # }
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/create.geotop.meteo.files.html b/docs/reference/create.geotop.meteo.files.html new file mode 100644 index 0000000..ba03a71 --- /dev/null +++ b/docs/reference/create.geotop.meteo.files.html @@ -0,0 +1,182 @@ + +Creates geotop meteo files from (a list of) 'zoo' objects — create.geotop.meteo.files • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Creates geotop meteo files from (a list of) 'zoo' objects

    +
    + +
    +
    create.geotop.meteo.files(
    +  x,
    +  format = "%d/%m/%Y %H:%M",
    +  file_prefix = "meteo",
    +  file_extension = ".txt",
    +  formatter = "%04d",
    +  na = "-9999",
    +  col.names = TRUE,
    +  row.names = FALSE,
    +  date_field = "Date",
    +  sep = ",",
    +  level = NULL,
    +  quote = FALSE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    'zoo' object or a list of 'zoo' object representing the meteorological station

    + + +
    format
    +

    string format representing the date, see as.POSIXlt. Default is "%d/%m/%Y %H:%M" (which is the same format used in geotop.inpts keyword InitDateDDMMYYYYhhmm)

    + + +
    file_prefix
    +

    string containing file prefix (full path). It correspos to the value of in geotop.inpts keyword MeteoFile)

    + + +
    file_extension
    +

    string containing the extensions of final files. Default is c(".txt")

    + + +
    formatter
    +

    string value. It is the decimal formatter contained in the file name and used in case the tabular data are referred at several points. Default is "%04d" . See sprintf .

    + + +
    na
    +

    NA value indicator. Default is "-9999". See write.table.

    + + +
    col.names
    +

    logical parameter. Default is TRUE. See write.table.

    + + +
    row.names
    +

    logical parameter. Default is FALSE. See write.table.

    + + +
    date_field
    +

    string value. Default is "Date", otherwise defined by the value of HeaderDateDDMMYYYYhhmmMeteo geotop keyword.

    + + +
    sep
    +

    string value. Default is ",". See write.table.

    + + +
    level
    +

    integer argument. See get.geotop.inpts.keyword.value for major details. Default is NULL and is ignored.

    + + +
    quote
    +

    logical parameter. Default is TRUE. See write.table.

    + + +
    ...
    +

    further arguments for write.table

    + +
    + + +
    +

    Examples

    +
    
    +library(geotopbricks)
    +data(bondone) ## It contains a "meteo" zoo object.
    +
    +
    +set.seed(12)
    +
    +file_prefix <- paste(tempdir(),"meteo",sep="/") 
    +level=2
    +out <- create.geotop.meteo.files(x=meteo,file_prefix=file_prefix,level=level) 
    +## It exports the "meteo" zoo object into a ASCII file for GEOtop
    +head(readLines(out))
    +#> [1] "Date,Iprec,AirT,RH,WindDir,WindSp,Swglob"            
    +#> [2] "18/08/2004 00:00,-9999,-9999,-9999,-9999,-9999,-9999"
    +#> [3] "18/08/2004 01:00,-9999,-9999,-9999,-9999,-9999,-9999"
    +#> [4] "18/08/2004 02:00,-9999,-9999,-9999,-9999,-9999,-9999"
    +#> [5] "18/08/2004 03:00,-9999,-9999,-9999,-9999,-9999,-9999"
    +#> [6] "18/08/2004 04:00,-9999,-9999,-9999,-9999,-9999,-9999"
    +out
    +#> [1] "/tmp/Rtmp7Hl4Jx/meteo0002.txt"
    +
    +
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/declared.geotop.inpts.keywords.html b/docs/reference/declared.geotop.inpts.keywords.html new file mode 100644 index 0000000..2dc5a6f --- /dev/null +++ b/docs/reference/declared.geotop.inpts.keywords.html @@ -0,0 +1,128 @@ + +Collects all keywords contained in the 'getop.inpts' configuration files and their values in a data frame object. — declared.geotop.inpts.keywords • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Collects all keywords contained in the 'getop.inpts' configuration files and their values in a data frame object.

    +
    + +
    +
    declared.geotop.inpts.keywords(
    +  wpath,
    +  inpts.file = "geotop.inpts",
    +  comment = "!",
    +  exceptions = "Date",
    +  warn = FALSE,
    +  no.comment = c("!>!", "!>>!"),
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    wpath
    +

    working directory containing GEOtop files

    + + +
    inpts.file
    +

    name of the GEOtop configuration file. Default is "geotop.inpts"

    + + +
    comment
    +

    comment indicator charcater. Default is "!"

    + + +
    exceptions
    +

    string vector. If keywords contain an element of this vector, the blank spaces in Value " " will not be removed.

    + + +
    warn
    +

    logical argument of readLines. Default is FALSE.

    + + +
    no.comment
    +

    string indicatos read as comment ones by GEOtop but they do not indicate comments by "geotopbricks" package.

    + + +
    ...
    +

    further arguments of readLines

    + +
    +
    +

    Value

    +

    a data frame with two columns: Keyword and Value

    +
    + + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/geotopbrick.html b/docs/reference/geotopbrick.html new file mode 100644 index 0000000..40faa33 --- /dev/null +++ b/docs/reference/geotopbrick.html @@ -0,0 +1,139 @@ + +geotopbrick — geotopbrick • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    geotopbrick method bla bla bla

    +
    + +
    +
    geotopbrick(x = NULL, ...)
    +
    +# Default S3 method
    +geotopbrick(x, ...)
    +
    +# S3 method for class 'zoo'
    +geotopbrick(x, layer = NULL, time = NULL, crs = NULL, timerange = NULL, ...)
    +
    +# S3 method for class 'RasterLayer'
    +geotopbrick(x, layer = NULL, time = NULL, ascpath = zoo(NULL), ...)
    +
    +# S3 method for class 'RasterBrick'
    +geotopbrick(x, layer = NULL, time = NULL, ascpath = zoo(NULL), ...)
    +
    +# S3 method for class 'GeotopRasterBrick'
    +geotopbrick(
    +  x,
    +  layer = NULL,
    +  time = NULL,
    +  crs = NULL,
    +  timerange = NULL,
    +  ascpath = NULL,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    a 'zoo' object returned by function pointer.to.maps.xyz.time or pointer.to.maps.xy.time or a GeotopRasterBrick-class object

    + + +
    ...
    +

    further arguments.

    + + +
    layer
    +

    layer at which raster maps are imported. If is NULL, maps ara no-zlayer distributed and zoo must be returend by pointer.to.maps.xy.time

    + + +
    time
    +

    vector of time instants at which geotop maps are imported

    + + +
    crs
    +

    coordinate system see RasterBrick-class

    + + +
    timerange
    +

    two-elememts vector containing the time range at which geotop maps are imported

    + + +
    ascpath
    +

    NULL object or a "zoo" S3 object containing the names of ascii maps provided by GEOtop

    + +
    +
    +

    Value

    +

    a GeotopRasterBrick-class

    +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/get.geotop.inpts.keyword.value.html b/docs/reference/get.geotop.inpts.keyword.value.html new file mode 100644 index 0000000..3579a49 --- /dev/null +++ b/docs/reference/get.geotop.inpts.keyword.value.html @@ -0,0 +1,330 @@ + +Importing a GEOtop Keyword and its Value into R — get.geotop.inpts.keyword.value • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    It returns the values of a keyword of "geotop.inpts" file or data frame with the suitable format.

    +
    + +
    +
    get.geotop.inpts.keyword.value(
    +  keyword,
    +  inpts.frame = NULL,
    +  vector_sep = NULL,
    +  col_sep = ",",
    +  numeric = FALSE,
    +  format = "%d/%m/%Y %H:%M",
    +  date = FALSE,
    +  tz = "Etc/GMT-1",
    +  raster = FALSE,
    +  file_extension = ".asc",
    +  add_wpath = FALSE,
    +  wpath = NULL,
    +  use.read.raster.from.url = TRUE,
    +  data.frame = FALSE,
    +  formatter = "%04d",
    +  level = 1,
    +  date_field = "Date",
    +  isNA = -9999,
    +  matlab.syntax = TRUE,
    +  projfile = "geotop.proj",
    +  start_date = NULL,
    +  end_date = NULL,
    +  ContinuousRecovery = 0,
    +  ContinuousRecoveryFormatter = "_crec%04d",
    +  zlayer.formatter = NULL,
    +  z_unit = c("centimeters", "millimeters"),
    +  geotop_z_unit = "millimeters",
    +  add_suffix_dir = NULL,
    +  MAXNROW = 4,
    +  header.only = FALSE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    keyword
    +

    keyword name

    + + +
    inpts.frame
    +

    data frame returned by declared.geotop.inpts.keywords or NULL. Default is NULL.

    + + +
    vector_sep
    +

    character value for the separator character if Keyword Value must be returned as a vector, otherwise it is NULL. Default is NULL, but if numeric or date are FALSE, vector_sep is set "," by default.

    + + +
    col_sep
    +

    character value for the separator character of columuns. It is used if Keyword Value is returned as a data frema or zoo object or list of these objects. Default is NULL, but is set ",".

    + + +
    numeric
    +

    logical value. If TRUE the Value has numeric type, otherwise it is a string or string vector. Default is FALSE.

    + + +
    format
    +

    string format representing the date, see as.POSIXlt, used if date is TRUE. Default is "%d/%m/%Y %H:%M" (which is the format used in geotop.inpts keyword InitDateDDMMYYYYhhmm)

    + + +
    date
    +

    logical value. If TRUE the Value is retured as POSIXlt date, otherwise it is a string or string vector. Default is FALSE.

    + + +
    tz
    +

    format string representing the time zone, see as.POSIXlt, used if date is TRUE. Default is "Etc/GMT-1" (until the previous version it was "A") which meens UTC +1.

    + + +
    raster
    +

    logical value. Default is FALSE. If TRUE function returns direclty the raster map as Raster-class object built with raster method.

    + + +
    file_extension
    +

    Extension to be added to the keyword if keyword is a file name. Default is ".asc"

    + + +
    add_wpath
    +

    logical value. Default is FALSE. If TRUE, the wpath string is attached to the keyword string value. It is automatically set TRUE if raster is TRUE.

    + + +
    wpath
    +

    working directory containing GEOtop files (included the inpts file). It is mandatory if raster is TRUE. See declared.geotop.inpts.keywords.

    + + +
    use.read.raster.from.url
    +

    logical value. Default is TRUE. If TRUE the RasterLayer are read with read.raster.from.url, istead of raster (otherwise). It is recomended in case the files whose paths are contained in x are remote and are 'http' addresses. In this cases the stand-alone method raster(x) does not always work and use.read.raster.from.url is necessary.

    + + +
    data.frame
    +

    logical value. It is an option for tabular data. If TRUE function returns direclty a data frame or a list of data frames as data.frame or zoo objects imported from the keyword-related files using read.table function. In this case the argument wpath (see declared.geotop.inpts.keywords) is mandatory. Default is FALSE.

    + + +
    formatter
    +

    string value. It is the decimal formatter contained in the file name and used in case the tabular data are referred at several points. Default is "%04d" . It is used in case data.frame is TRUE.

    + + +
    level
    +

    integer values. Numbers incating all the identandification numbers of the files containing the requested data frames. Default is 1, correspondig to the decimal formatter "0001". See examples.

    + + +
    date_field
    +

    string value. Default is "Date", otherwise defined by the value of HeaderDateDDMMYYYYhhmmMeteo geotop keyword. It is used only if the argument data.frame is TRUE. If it is NULL or NA the function return a list of generic data.frame object(s), otherwise link{zoo} object(s). See the arguments tz and format for Date formatting.

    + + +
    isNA
    +

    numeric value indicating NA in geotop ascii files. Default is -9999.00

    + + +
    matlab.syntax
    +

    logical value. Default is FALSE. If TRUE a vector is written in a string according to *.m file syntax. Warning: this synstax is not read by GEOtop.

    + + +
    projfile
    +

    fileneme of the GEOtop projection file. Default is geotop.proj.

    + + +
    start_date, end_date
    +

    null objects or dates in POSIXlt format between which the variables are returned. It is enabled in case that date_field is not NULL or NA and data.frame is TRUE. Default is NULL.

    + + +
    ContinuousRecovery
    +

    integer value. Default is 0. It is used for tabular output data and is the number of times GEOtop simulation broke during its running and was re-launched with 'Contiuous Recovery' option.

    + + +
    ContinuousRecoveryFormatter
    +

    character string. Default is '_crec%04d'. It is used only for tabular output data and if ContinuousRecovery is equal or greater than 1.

    + + +
    zlayer.formatter
    +

    decimal formatter. It is used if data.frame==TRUE and the columns refers to different soil depths. Default is NULL.

    + + +
    z_unit
    +

    z coordinate measurement unit. GEOtop values expressed in millimeters which are converted to centimeters by default. Default is c("centimeters","millimeters"). Otherwise can be the ratio between the unit and one meter. It is used if zlayer.formatter=="z%04d" or similar.

    + + +
    geotop_z_unit
    +

    z coordinate measurement unit used by GEOtop. Default is millimeters. It is used if zlayer.formatter=="z%04d" or similar.

    + + +
    add_suffix_dir
    +

    character string. Add a suffix at the directory reported in the keyword value

    + + +
    MAXNROW
    +

    maximum number accepted for data.frema output. Default is 4. It is used in case of data.frame==TRUE. In case the number of records in the function output is less than MAXNROW , function returns neither data.frame nor zoo objects but only the keyword value.

    + + +
    header.only
    +

    logical value. Default is FALSE. If it is TRUE and data.frame==TRUE, only file hedaer with variable names is returned by the function.

    + + +
    ...
    +

    further arguments of declared.geotop.inpts.keywords

    + +
    +
    +

    Value

    +

    the keyword value

    +
    +
    +

    Note

    +

    If inpts.frame is NULL, inpts.frame will be obtained by calling the function declared.geotop.inpts.keywords with ... arguments.

    +
    + +
    +

    Examples

    +
    
    +library(geotopbricks)
    +
    +#Simulation working path
    + 
    +
    +
    +wpath <- 
    +'https://raw.githubusercontent.com/ecor/geotopbricks_doc/master/simulations/panola13_run2xC_test3'
    +## URL path (RAW VERSION) of
    +## https://github.com/ecor/geotopbricks_doc/tree/master/simulations/panola13_run2xC_test3
    +prefix <- get.geotop.inpts.keyword.value("SoilLiqWaterPressTensorFile",wpath=wpath)
    +
    +slope <- get.geotop.inpts.keyword.value("SlopeMapFile",raster=TRUE,wpath=wpath) 
    +bedrock_depth <- get.geotop.inpts.keyword.value("BedrockDepthMapFile",raster=TRUE,wpath=wpath) 
    +
    +layers <- get.geotop.inpts.keyword.value("SoilLayerThicknesses",numeric=TRUE,wpath=wpath)
    +names(layers) <- paste("L",1:length(layers),sep="")
    +
    +##### set van genuchten parameters to estimate water volume 
    +theta_sat <- get.geotop.inpts.keyword.value("ThetaSat",numeric=TRUE,wpath=wpath)
    +theta_res <- get.geotop.inpts.keyword.value("ThetaRes",numeric=TRUE,wpath=wpath)
    +alphaVG <-  get.geotop.inpts.keyword.value("AlphaVanGenuchten",
    +numeric=TRUE,wpath=wpath) # expressed in mm^-1
    +
    +nVG <-  get.geotop.inpts.keyword.value("NVanGenuchten",numeric=TRUE,wpath=wpath) 
    +
    +
    +##### end set van genuchten parameters to estimate water volume
    +
    +
    +##### set meteo data
    +# \donttest{
    +
    +tz <- "Etc/GMT-1"  ## See help(timezones) In particular:
    +## Most platforms support time zones of the form Etc/GMT+n 
    +## and Etc/GMT-n (possibly also without prefix Etc/), 
    +## which assume a fixed offset from UTC (hence no DST). 
    +## Contrary to some expectations 
    +## (but consistent with names such as PST8PDT), negative offsets are times ahead of (east of) UTC, 
    +## positive offsets are times behind (west of) UTC.
    +start <-  get.geotop.inpts.keyword.value("InitDateDDMMYYYYhhmm",
    +date=TRUE,wpath=wpath,tz=tz) 
    +end <- get.geotop.inpts.keyword.value("EndDateDDMMYYYYhhmm",
    +date=TRUE,wpath=wpath,tz=tz) 
    +
    +nmeteo <- get.geotop.inpts.keyword.value("NumberOfMeteoStations",
    +numeric=TRUE,wpath=wpath)
    +level <- 1:nmeteo
    +
    +## set meteo data
    +
    + meteo <- get.geotop.inpts.keyword.value("MeteoFile",wpath=wpath,data.frame=TRUE,
    +       level=level,start_date=start,end_date=end,tz=tz)
    +# }
    +
    +##### end set meteo data
    +
    +## IMPORTING AN OUTPUT SOIL MOISTURE PROFILE: 
    +
    +
    +wpath <-  paste0(
    +'https://raw.githubusercontent.com/ecor/geotopbricks_doc/',
    +'master/simulations/Muntatschini_pnt_1_225_B2_004')
    +## URL Path (RAW VERSION) of 
    +## https://github.com/ecor/geotopbricks_doc/tree/master/simulations/Muntatschini_pnt_1_225_B2_004
    +# \donttest{
    +  SMC  <- get.geotop.inpts.keyword.value("SoilLiqContentProfileFile",
    +          wpath=wpath,data.frame=TRUE,date_field="Date12.DDMMYYYYhhmm.",
    +          formatter="%04d")
    +
    +    SMCz  <- get.geotop.inpts.keyword.value("SoilLiqContentProfileFile",
    +         wpath=wpath,data.frame=TRUE,date_field="Date12.DDMMYYYYhhmm.",
    +          formatter="%04d",zlayer.formatter="z%04d")
    +# }
    +
    +
    +    
    +
    +
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/get.geotop.points.html b/docs/reference/get.geotop.points.html new file mode 100644 index 0000000..5b758d4 --- /dev/null +++ b/docs/reference/get.geotop.points.html @@ -0,0 +1,132 @@ + +Get a sf object for Meteorological Stations or Control Points in a GEOtop simulation — get.geotop.points • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Get a sf object for Meteorological Stations or Control Points in a GEOtop simulation

    +
    + +
    +
    get.geotop.points(
    +  prefix = c("MeteoStation", "CoordinatePoint"),
    +  suffixes = c("Code", "Elevation", "Source"),
    +  coord_suffixes = list(MeteoStation = c("CoordinateX", "CoordinateY"), CoordinatePoint =
    +    c("X", "Y")),
    +  wpath,
    +  ...,
    +  vector_sep = ","
    +)
    +
    + +
    +

    Arguments

    + + +
    prefix
    +

    keyword prefix

    + + +
    suffixes
    +

    keyword suffixes

    + + +
    coord_suffixes
    +

    coordinate keyword suffixes. Default is c("PointX","PointY")

    + + +
    wpath
    +

    GEOtop simulation path

    + + +
    vector_sep, ...
    +

    further arguments for get.geotop.inpts.keyword.value

    + +
    + +
    +

    Examples

    +
    
    +# \donttest{
    +###See simulation template: "https://github.com/ecor/geotopbricks_doc/tree/master/template/sumava"
    +wpath <- "https://raw.githubusercontent.com/ecor/geotopbricks_doc/master/template/sumava/"
    +## system.file("template/sumava",package="geotopbricks") 
    +out <- get.geotop.points(wpath=wpath)
    +#> [1] "Code"        "Elevation"   "Source"      "CoordinateX" "CoordinateY"
    +#> [1] "CoordinateX" "CoordinateY"
    +out <- get.geotop.points(prefix="CoordinatePoint",suffix=c("Code","Source"),wpath=wpath)
    +#> [1] "Code"   "Source" "X"      "Y"     
    +#> [1] "X" "Y"
    +out <- get.geotop.points(prefix="MeteoStation",suffix=c("Code","Source"),wpath=wpath)
    +#> [1] "Code"        "Source"      "CoordinateX" "CoordinateY"
    +#> [1] "CoordinateX" "CoordinateY"
    +
    +# }
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/get.geotop.recovery.state.html b/docs/reference/get.geotop.recovery.state.html new file mode 100644 index 0000000..a45d9c8 --- /dev/null +++ b/docs/reference/get.geotop.recovery.state.html @@ -0,0 +1,151 @@ + +This function saves all spatially distrubuted information contained in the recovery folder into a comprehensive list object. — get.geotop.recovery.state • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    This function saves all spatially distrubuted information contained in the recovery folder into a comprehensive list object.

    +
    + +
    +
    get.geotop.recovery.state(
    +  recFolder,
    +  xx = "0000",
    +  formatter = "L%04d",
    +  extension = ".asc",
    +  nsoillayers = 10,
    +  layersFromDir = FALSE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    recFolder
    +

    directory when recvery maps are set. In GEOtop it is ...

    + + +
    xx
    +

    charcter String. Default is "0000"

    + + +
    formatter
    +

    string character for the the decimal formatter to be used. Default is "L%04d".

    + + +
    extension
    +

    file estension used for asccii recovery map files. It must contains '.' as the first character. Defaut is ".asc" .

    + + +
    nsoillayers
    +

    number of soil layers used in the GEOtop simulation.

    + + +
    layersFromDir
    +

    logical value. If is TRUE the number of soil/snow (vertical) layers used in the GEOtop simulation is automatically calculated and cannot be assigned through nsoillayers.

    + + +
    ...
    +

    further arguments

    + +
    +
    +

    Value

    +

    a list object containining all recovery raster maps.

    +
    +
    +

    Note

    +

    This function has been used with the built 1.225-9 of GEOtop .

    +
    + +
    +

    Author

    +

    Emanuele Cordano

    +
    + +
    +

    Examples

    +
    library(geotopbricks)
    +example_Rscript <- system.file('template/example.geotop.recovery.state.R',package="geotopbricks")
    +example_Rscript
    +#> [1] "/tmp/RtmpnGzYTO/temp_libpath30e06e28ea68a9/geotopbricks/template/example.geotop.recovery.state.R"
    +
    +# Not Run because it elapses too long time!!! 
    +# Please Uncomment the following line to run by yourself!!!
    +# source(example_Rscript)
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/getProjection.html b/docs/reference/getProjection.html new file mode 100644 index 0000000..2ac0c41 --- /dev/null +++ b/docs/reference/getProjection.html @@ -0,0 +1,116 @@ + +It reads the CRS metadata utilzed in a GEOtop Simulation — getProjection • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    It reads the CRS metadata utilzed in a GEOtop Simulation

    +
    + +
    +
    getProjection(x, cond = TRUE, ...)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    name and full path of the file containimg CRS information

    + + +
    cond
    +

    logical value. If FALSE the function returns NA. Default is TRUE.

    + + +
    ...
    +

    futher arguments

    + +
    +
    +

    Value

    +

    A string corresponding the projection and CRS if the argument cond is TRUE.

    +
    + +
    +

    Examples

    +
    library(geotopbricks)
    +
    +wpath <- 'https://raw.githubusercontent.com/ecor/geotopbricks_doc/master/simulations/idroclim_test1'
    +## URL path  (RAW VERSION) of 
    +## https://github.com/ecor/geotopbricks_doc/tree/master/simulations/idroclim_test1
    +if (FALSE) { # \dontrun{
    +
    +x <- paste(wpath,"geotop.proj",sep="/")
    +
    +
    +crs <- getProjection(x)
    +} # }
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/getvalues.brick.at.depth.html b/docs/reference/getvalues.brick.at.depth.html new file mode 100644 index 0000000..c77c367 --- /dev/null +++ b/docs/reference/getvalues.brick.at.depth.html @@ -0,0 +1,135 @@ + +Interpolates the values of a 'brick' at a certain depth and returns the map of brick values at the "depth" level — getvalues.brick.at.depth • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Interpolates the values of a 'brick' at a certain depth and returns the map of brick values at the "depth" level

    +
    + +
    +
    getvalues.brick.at.depth(x, depth, layers, i0 = NULL, verify = FALSE, ...)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    a 'RasterBrick' or a three-dimensional array

    + + +
    depth
    +

    depth map, generally a 'RasterLayer' object

    + + +
    layers
    +

    vector of layer thickness

    + + +
    i0
    +

    a 'Raster' containing the number of soil laver just over the bedrock. Default is NULL and is then calculated.

    + + +
    verify
    +

    logical. Default is FALSE. If it is TRUE, it verifies that function is working correctly.

    + + +
    ...
    +

    further argument

    + +
    +
    +

    Value

    +

    a list of 'Raster' maps:

    +

    i0 a 'Raster' containing the number of soil laver just over the bedrock

    +

    val_z0 a 'Raster' containing the values of x at the i0-th layer

    +

    val_z1 a 'Raster' containing the values of x at the (i0+1)-th layer

    +

    z0 a 'Raster' containing the depth of the center of the i0-th layer

    +

    z1 a 'Raster' containing the depth of the center of the (i0+1)-th layer

    +
    +
    +

    Note

    +

    x and depth or i0 must cover the same spatial region.

    +
    + + +
    +

    Examples

    +
    
    +library(geotopbricks)
    +# The examples is the following R script conteined in a 'inst' directory of the package source
    +f <- system.file("doc/examples/example.getvalues.brick.at.depth.R",package="geotopbricks")
    +#  source(f) # Uncomment this line to run the example. 
    +# You can copy the example file using file.copy(from=f,to=....,...) See file.copy documentation
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..3af64bc --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,206 @@ + +Package index • geotopbricks + + +
    +
    + + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    GeotopRasterBrick-class GeotopRasterBrick

    +

    GeotopRasterBrick-class

    +

    KML(<GeotopRasterBrick>)

    +

    KML

    +

    Ops(<GeotopRasterBrick>,<GeotopRasterBrick>) Ops(<GeotopRasterBrick>,<numeric>) Ops(<numeric>,<GeotopRasterBrick>)

    +

    Ops

    +

    argsParser()

    +

    Parser of an argument string

    +

    bondone

    +

    Bondone Dataset

    +

    brick(<zoo>) brick(<GeotopRasterBrick>)

    +

    brick

    +

    brick.decimal.formatter()

    +

    Imports a brick of raster ascii maps into a 'brick' object

    +

    brickFromOutputSoil3DTensor() rasterFromOutput2DMap()

    +

    brickFromOutputSoil3DTensor

    +

    create.geotop.inpts.keyword()

    +

    Creates an 'geotop.inpts' files the keyword and their values of a date.frame like the one returned by declared.geotop.inpts.keywords

    +

    create.geotop.meteo.files()

    +

    Creates geotop meteo files from (a list of) 'zoo' objects

    +

    declared.geotop.inpts.keywords()

    +

    Collects all keywords contained in the 'getop.inpts' configuration files and their values in a data frame object.

    +

    geotopbrick()

    +

    geotopbrick

    +

    get.geotop.inpts.keyword.value()

    +

    Importing a GEOtop Keyword and its Value into R

    +

    get.geotop.points()

    +

    Get a sf object for Meteorological Stations or Control Points in a GEOtop simulation

    +

    get.geotop.recovery.state()

    +

    This function saves all spatially distrubuted information contained in the recovery folder into a comprehensive list object.

    +

    getProjection()

    +

    It reads the CRS metadata utilzed in a GEOtop Simulation

    +

    getvalues.brick.at.depth()

    +

    Interpolates the values of a 'brick' at a certain depth and returns the map of brick values at the "depth" level

    +

    max_value()

    +

    max_value

    +

    min_value()

    +

    min_value

    +

    plot(<GeotopRasterBrick>,<ANY>)

    +

    plot

    +

    pointer.to.maps.xyz.time()

    +

    pointer.to.maps.xyz.time

    +

    read.ascii.vectorized.brick()

    +

    Read a text file containing values and matedata of a z-layer brick referred to a time instant (e.g. date). The file is formatted like an ascii format like 'geotop.inpts' file.

    +

    read.raster.from.url()

    +

    It imports a 'RasterLayer' object in Escri-Asci format from a URL 'http(s)://....<FILENAME>.asc

    +

    read.vectorized.geotop.recovery()

    +

    Reads a text file like the one generated by write.vectorized.geotop.recovery

    +

    replace.keyword()

    +

    It replaces some keyword values of geotop.inpts file with the ones of anoter *.inpts value

    +

    set.geotop.recovery.state()

    +

    This function re-writes the recovery ascii raster maps in a given folder

    +

    vertical.aggregate.brick.within.depth()

    +

    Aggregates with a mean or an addition on the vertical profile the values of a 'brick' within a certain depth and returns the vertical aggregated map

    +

    write.ascii.vectorized.brick()

    +

    Writes a z-layer brick referred to a time instant (e.g. date) in an ascii format like 'geotop.inpts' file.

    +

    write.geotop.table()

    +

    Writes an R object (data.frame or zoo) into a CSV file readible by GEOtop.

    +

    write.vectorized.geotop.recovery()

    +

    It writes a list object returened by get.geotop.recovery.state as a string vector or in a text file, following *.inpts or Matlab-like syntax.

    +

    write.vectorized.variable.in.string()

    +

    Writes one or more variables (scalars, vectors or Rasters) in a string each, following *.inpts or Matlab-like syntax.

    +

    writeRasterxGEOtop()

    +

    This function uses writeRaster to create .asc maps which can be read by GEOtop

    +

    zoo-class

    +

    A GeotopRasterBrick: an object to manage raster maps provied by GEOtop!!

    + + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/max_value.html b/docs/reference/max_value.html new file mode 100644 index 0000000..0158f83 --- /dev/null +++ b/docs/reference/max_value.html @@ -0,0 +1,96 @@ + +max_value — max_value • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Gets the maximum (scalar) values of a GeotopRasterBrick object

    +
    + +
    +
    max_value(x, na.rm = TRUE, ...)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    a GeotopRasterBrick object.

    + + +
    na.rm, ...
    +

    further arguments for max.

    + +
    +
    +

    Value

    +

    the maximum (scalar) values of a GeotopRasterBrick object

    +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/min_value.html b/docs/reference/min_value.html new file mode 100644 index 0000000..8e8677f --- /dev/null +++ b/docs/reference/min_value.html @@ -0,0 +1,96 @@ + +min_value — min_value • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Gets the minimum (scalar) values of a GeotopRasterBrick object

    +
    + +
    +
    min_value(x, na.rm = TRUE, ...)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    a GeotopRasterBrick object.

    + + +
    na.rm, ...
    +

    further arguments foe min.

    + +
    +
    +

    Value

    +

    the minimum (scalar) values of a GeotopRasterBrick object

    +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/plot-methods.html b/docs/reference/plot-methods.html new file mode 100644 index 0000000..f54745f --- /dev/null +++ b/docs/reference/plot-methods.html @@ -0,0 +1,119 @@ + +plot — plot • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    plot method for a GeotopRasterBrick object

    +
    + +
    +
    # S4 method for class 'GeotopRasterBrick,ANY'
    +plot(x, y = NULL, ...)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    the GeotopRasterBrick object

    + + +
    y
    +

    further argument

    + + +
    ...
    +

    further argument for S4 method plot for Raster object.

    + +
    +
    +

    See also

    + +
    + +
    +

    Examples

    +
    
    +
    +library(geotopbricks)
    +# The examples is the following R script conteined in a 'inst' directory of the package source
    +f <- system.file("doc/examples/example.plot.GeotopRasterBrick.R",package="geotopbricks")
    +#  source(f) # Uncomment this line to run the example. 
    +# You can copy the example file using file.copy(from=f,to=....,...) See file.copy documentation
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/pointer.to.maps.xyz.time.html b/docs/reference/pointer.to.maps.xyz.time.html new file mode 100644 index 0000000..0f390ba --- /dev/null +++ b/docs/reference/pointer.to.maps.xyz.time.html @@ -0,0 +1,123 @@ + +pointer.to.maps.xyz.time — pointer.to.maps.xyz.time • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    'pointer.to.maps.xyz.time' function (obsolete)

    +
    + +
    +
    pointer.to.maps.xyz.time(
    +  wpath,
    +  map.prefix = "thetaliq",
    +  suffix = "L%04dN%04d.asc",
    +  zoo.index = NULL,
    +  ntime,
    +  nlayers
    +)
    +
    + +
    +

    Arguments

    + + +
    wpath
    +

    complete working path to *.asc maps are saved

    + + +
    map.prefix
    +

    string prefix name map before

    + + +
    suffix
    +

    z-time or time suffix plus file extention character string. Default for GEOtop application is "L%04dN%04d.asc" for xy+z+time maps or "N%04d.asc" for xy+time maps.

    + + +
    zoo.index
    +

    time or date index. Default is NULL , otherwise function returns a zoo object with zoo.index as index.

    + + +
    ntime
    +

    number of time instant. If zoo.index is not NULL, it is calculated from zoo.index length.

    + + +
    nlayers
    +

    number of vertical layers.

    + +
    +
    +

    Value

    +

    A data.frame or zoo object containig the paths to maps fpr each time and z layer.

    +
    +
    +

    Author

    +

    Emanuele Cordano

    +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/read.ascii.vectorized.brick.html b/docs/reference/read.ascii.vectorized.brick.html new file mode 100644 index 0000000..5a4d381 --- /dev/null +++ b/docs/reference/read.ascii.vectorized.brick.html @@ -0,0 +1,129 @@ + +Read a text file containing values and matedata of a z-layer brick referred to a time instant (e.g. date). The file is formatted like an ascii format like 'geotop.inpts' file. — read.ascii.vectorized.brick • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Read a text file containing values and matedata of a z-layer brick referred to a time instant (e.g. date). The file is formatted like an ascii format like 'geotop.inpts' file.

    +
    + +
    +
    read.ascii.vectorized.brick(
    +  file = NULL,
    +  comment = "!",
    +  crs = "",
    +  NAflag = -9999,
    +  matlab.syntax = FALSE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    file
    +

    file name to write

    + + +
    comment
    +

    character. Comment indicator. Default is "!".

    + + +
    crs
    +

    Character or object of class CRS. PROJ4 type description of a Coordinate Reference System (map projection) (optional). See brick or raster.

    + + +
    NAflag
    +

    numeric. Dafauli is -9999, see writeRasterxGEOtop.

    + + +
    matlab.syntax
    +

    logical value. Default is FALSE. If TRUE the file syntax is like the one of a *.m Matlab script file.

    + + +
    ...
    +

    further aguments inserted as attribute

    + +
    +
    +

    Value

    +

    the RasterBrick-class object

    +
    + + +
    +

    Examples

    +
    # see the examples of read.ascii.vectorized.brick
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/read.raster.from.url.html b/docs/reference/read.raster.from.url.html new file mode 100644 index 0000000..d49bbe6 --- /dev/null +++ b/docs/reference/read.raster.from.url.html @@ -0,0 +1,108 @@ + +It imports a 'RasterLayer' object in Escri-Asci format from a URL 'http(s)://....<FILENAME>.asc — read.raster.from.url • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    It imports a 'RasterLayer' object in Escri-Asci format from a URL 'http(s)://....<FILENAME>.asc

    +
    + +
    +
    read.raster.from.url(x, header_nrow = 6, ...)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    the charcater string containing the URL address

    + + +
    header_nrow
    +

    Number of header in the ASCII grid format. Deafault is 6. See https://en.wikipedia.org/wiki/Esri_grid

    + + +
    ...
    +

    additional arguments

    + +
    +
    +

    Value

    +

    a 'RasterLayer' object

    +
    +
    +

    Note

    +

    This function reads a local or remote text files formatted as https://en.wikipedia.org/wiki/Esri_grid and creates a 'RasterLayer' object.

    +
    +
    +

    See also

    + +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/read.vectorized.geotop.recovery.html b/docs/reference/read.vectorized.geotop.recovery.html new file mode 100644 index 0000000..8ca68b7 --- /dev/null +++ b/docs/reference/read.vectorized.geotop.recovery.html @@ -0,0 +1,136 @@ + +Reads a text file like the one generated by write.vectorized.geotop.recovery — read.vectorized.geotop.recovery • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    #. containing values and matedata of a z-layer brick referred to a time instant (e.g. date). The file is formatted like an ascii format like 'geotop.inpts' file.

    +
    + +
    +
    read.vectorized.geotop.recovery(
    +  file = file,
    +  comment = "!",
    +  matlab.syntax = TRUE,
    +  xx = "0000",
    +  formatter = "L%04d",
    +  extension = ".asc",
    +  NAflag = -9999,
    +  crs = "",
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    file
    +

    file name to write

    + + +
    comment
    +

    character. Comment indicator. Default is "!".

    + + +
    matlab.syntax
    +

    logical value. Default is TRUE. If TRUE the file syntax is like the one of a *.m Matlab script file.

    + + +
    formatter, extension, xx
    +

    see get.geotop.recovery.state.

    + + +
    NAflag
    +

    numeric. Default is -9999, see writeRasterxGEOtop.

    + + +
    crs
    +

    Character or object of class CRS. PROJ4 type description of a Coordinate Reference System (map projection) (optional). See brick or raster.

    + + +
    ...
    +

    further aguments inserted as attribute

    + +
    +
    +

    Value

    +

    a list object like get.geotop.recovery.state

    +
    + + +
    +

    Examples

    +
    # see the examples of read.ascii.vectorized.brick
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/replace.keyword.html b/docs/reference/replace.keyword.html new file mode 100644 index 0000000..570ea6e --- /dev/null +++ b/docs/reference/replace.keyword.html @@ -0,0 +1,137 @@ + +It replaces some keyword values of geotop.inpts file with the ones of anoter *.inpts value — replace.keyword • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    It replaces some keyword values of geotop.inpts file with the ones of anoter *.inpts value

    +
    + +
    +
    replace.keyword(
    +  x,
    +  y = "geotop.inpts",
    +  file.output = NULL,
    +  write.file.output = TRUE,
    +  wpath = NULL,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    filename of the *.inpts with the "new" keyword value

    + + +
    y
    +

    filename of the *.inpts with the "old" keyword value. Default is "geotop.inpts".

    + + +
    file.output
    +

    filename where to write the comprehensive new geotop.inpts file. If it is NULL (default), the fileneme is assigned by y.

    + + +
    write.file.output
    +

    logical value. If it is TRUE, the output of the function is written in he file file.output.

    + + +
    wpath
    +

    working path to the GEOtop simulation folder containing the x and y files.

    + + +
    ...
    +

    further arguments

    + +
    +
    +

    Details

    +

    This function repleces some keword values of y with the ones indicated in y. It is useful to replace the meteo station metedata, for instance, when the meteorological station of a study cases are modified. +The function returns the new geotop.inpts file as a vector of character strings. If write.file.output==TRUE, the output is written in an extarnal file, e.g. "geotop.inpts" newly (this option is suggested).

    +
    +
    +

    Author

    +

    Emanuele Cordano

    +
    + +
    +

    Examples

    +
    
    +library(geotopbricks)
    +wpath <- system.file('template/meteo_ex',package="geotopbricks")
    +x <- "meteo.inpts"
    +zl <- replace.keyword(x,wpath=wpath,write.file.output=FALSE)
    +#> Warning: incomplete final line found on '/tmp/RtmpnGzYTO/temp_libpath30e06e28ea68a9/geotopbricks/template/meteo_ex/geotop.inpts'
    +
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/set.geotop.recovery.state.html b/docs/reference/set.geotop.recovery.state.html new file mode 100644 index 0000000..b65334a --- /dev/null +++ b/docs/reference/set.geotop.recovery.state.html @@ -0,0 +1,110 @@ + +This function re-writes the recovery ascii raster maps in a given folder — set.geotop.recovery.state • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    This function re-writes the recovery ascii raster maps in a given folder

    +
    + +
    +
    set.geotop.recovery.state(rec, newRecFolder, ...)
    +
    + +
    +

    Arguments

    + + +
    rec
    +

    a list object returened by get.geotop.recovery.state

    + + +
    newRecFolder
    +

    directory where to write all recovery raster asccii maps

    + + +
    ...
    +

    further arguments

    + +
    + +
    +

    Author

    +

    Emanuele Cordano

    +
    + +
    +

    Examples

    +
    # See the examples of the 'get.geotop.recovery.state' function
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/vertical.aggregate.brick.within.depth.html b/docs/reference/vertical.aggregate.brick.within.depth.html new file mode 100644 index 0000000..6a5bfea --- /dev/null +++ b/docs/reference/vertical.aggregate.brick.within.depth.html @@ -0,0 +1,160 @@ + +Aggregates with a mean or an addition on the vertical profile the values of a 'brick' within a certain depth and returns the vertical aggregated map — vertical.aggregate.brick.within.depth • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Aggregates with a mean or an addition on the vertical profile the values of a 'brick' within a certain depth and returns the vertical aggregated map

    +
    + +
    +
    vertical.aggregate.brick.within.depth(
    +  x,
    +  depth = NULL,
    +  layers = NULL,
    +  i0 = NULL,
    +  verify = FALSE,
    +  FUN = identity,
    +  divide.by.depth = FALSE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    a 'RasterBrick' or a three-dimensional array

    + + +
    depth
    +

    depth map, generally a 'RasterLayer' object

    + + +
    layers
    +

    vector of layer thickness

    + + +
    i0
    +

    a 'Raster' containing the number of soil laver just over the bedrock. Default is NULL and is then calculated.

    + + +
    verify
    +

    logical. Default is FALSE. If it is TRUE, it verifies that function is working correctly.

    + + +
    FUN
    +

    function used for aggregation. If missing, identity is the default value.

    + + +
    divide.by.depth
    +

    logical. If TRUE the function returns the 'mean' value, otherwise a a cumulate value. Default is FALSE.

    + + +
    ...
    +

    further argument for FUN

    + +
    +
    +

    Value

    +

    a list of 'Raster' maps:

    +

    i0 a 'Raster' containing the number of soil laver just over the bedrock

    + +

    z0 a 'Raster' containing the depth of the center of the i0-th layer

    +

    result a 'Raster' containing the aggregated map

    +
    +
    +

    Note

    +

    x and depth or i0 must cover the same spatial region.

    +
    + + +
    +

    Examples

    +
    
    +library(geotopbricks)
    +# The examples is the following R script conteined 
    +# in a 'inst' directory of the package source
    +f <- system.file("doc/examples/example.vertical.aggregate.brick.within.depth.R",
    +package="geotopbricks")
    +#  source(f) # Uncomment this line to run the example. 
    +# You can copy the example file using file.copy(from=f,to=....,...) See file.copy documentation
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/write.ascii.vectorized.brick.html b/docs/reference/write.ascii.vectorized.brick.html new file mode 100644 index 0000000..9938e44 --- /dev/null +++ b/docs/reference/write.ascii.vectorized.brick.html @@ -0,0 +1,151 @@ + +Writes a z-layer brick referred to a time instant (e.g. date) in an ascii format like 'geotop.inpts' file. — write.ascii.vectorized.brick • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Writes a z-layer brick referred to a time instant (e.g. date) in an ascii format like 'geotop.inpts' file.

    +
    + +
    +
    write.ascii.vectorized.brick(
    +  b,
    +  file = NULL,
    +  header = NULL,
    +  overwrite = TRUE,
    +  NAflag = -9999,
    +  matlab.syntax = FALSE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    b
    +

    a RasterBrick-class or GeotopRasterBrick-class object

    + + +
    file
    +

    file name to write

    + + +
    header
    +

    character string vector for header text lines. If missing, a default header is written. #Default is c("! header").

    + + +
    overwrite
    +

    logical. Default is TRUE, see writeRaster.

    + + +
    NAflag
    +

    numeric. Default is -9999, see writeRasterxGEOtop.

    + + +
    matlab.syntax
    +

    logical value. Default is FALSE. If TRUE the file syntax is like the one of a *.m Matlab script file.

    + + +
    ...
    +

    further aguments inserted as attribute

    + +
    +
    +

    Value

    +

    the string vector possibly written in file.

    +
    +
    +

    Note

    +

    Add Quote if necessary. This function is NOT maintained and will be DEPRECATED.

    +
    + + +
    +

    Examples

    +
    ## Not Run
    +## library(geotopbricks)
    +## library(raster)
    +## file <- system.file("doc/examples/snowthickness",package="geotopbricks")
    +## file <- paste(file,"SnowThickness0000L%04d.asc",sep="/")
    +## b <- brick.decimal.formatter(file=file,nlayers=15)
    +## nlayers(b)
    +## names(b)
    +## file <- "snow.txt"
    +## btext <- write.ascii.vectorized.brick(b,Date="1/1/2009",file="snow.txt")
    +## The printed object
    +## str(btext)
    +## bb <- read.ascii.vectorized.brick(file = file) 
    +## bf <- abs(as.matrix(bb[[1]]-b[[1]]))<.Machine$double.eps^0.5
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/write.geotop.table.html b/docs/reference/write.geotop.table.html new file mode 100644 index 0000000..3b3cfd7 --- /dev/null +++ b/docs/reference/write.geotop.table.html @@ -0,0 +1,135 @@ + +Writes an R object (data.frame or zoo) into a CSV file readible by GEOtop. — write.geotop.table • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Writes an R object (data.frame or zoo) into a CSV file readible by GEOtop.

    +
    + +
    +
    write.geotop.table(
    +  x,
    +  file,
    +  wpath = NULL,
    +  tz = "Etc/GMT-1",
    +  date_field = "Date12.DDMMYYYYhhmm.",
    +  file_end = "",
    +  sep = ",",
    +  format = "%d/%m/%Y %H:%M",
    +  na = "-9999",
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    R object (data.frame or zoo) to be exported and written.

    + + +
    file
    +

    filename

    + + +
    wpath
    +

    working path to the GEOtop simlation. If wpath is not NULL , filename will be put in wpath.

    + + +
    tz
    +

    time zone. Default is "Etc/GMT-1". See get.geotop.inpts.keyword.value fur further details.

    + + +
    date_field
    +

    string used for date-time field. Deafult is "Date12.DDMMYYYYhhmm.". See get.geotop.inpts.keyword.value fur further details.

    + + +
    file_end
    +

    suffix of the file name (file) (optional). Default is "".

    + + +
    sep
    +

    separator character. Default is ",". See write.table fur further details.

    + + +
    format
    +

    date time format. Default is "%d/%m/%Y %H:%M". See get.geotop.inpts.keyword.value fur further details.

    + + +
    na
    +

    string for unassigned values. Defaults is "-9999". See write.table fur further details.

    + + +
    ...
    +

    further arguments for write.table.

    + +
    + +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/write.vectorized.geotop.recovery.html b/docs/reference/write.vectorized.geotop.recovery.html new file mode 100644 index 0000000..4c618e2 --- /dev/null +++ b/docs/reference/write.vectorized.geotop.recovery.html @@ -0,0 +1,141 @@ + +It writes a list object returened by get.geotop.recovery.state as a string vector or in a text file, following *.inpts or Matlab-like syntax. — write.vectorized.geotop.recovery • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    It writes a list object returened by get.geotop.recovery.state as a string vector or in a text file, following *.inpts or Matlab-like syntax.

    +
    + +
    +
    write.vectorized.geotop.recovery(
    +  rec,
    +  file = NULL,
    +  header = NULL,
    +  overwrite = TRUE,
    +  NAflag = -9999,
    +  matlab.syntax = TRUE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    rec
    +

    a list object returened by get.geotop.recovery.state

    + + +
    file
    +

    ascii text file name whrere to write the string vector

    + + +
    header
    +

    character string vector for header text lines. If missing, a default header is written. Default is c("! header") or he one assigned by matlab.syntax.

    + + +
    overwrite
    +

    logical. Default is TRUE, see writeRaster.

    + + +
    NAflag
    +

    numeric. Default is -9999, see writeRasterxGEOtop.

    + + +
    matlab.syntax
    +

    logical value. Default is TRUE. If TRUE the file syntax is like the one of a *.m Matlab script file.

    + + +
    ...
    +

    further aguments inserted as attribute

    + +
    +
    +

    Value

    +

    a string vector containg the rec variables.

    +
    +
    +

    Note

    +

    Add Quote if necessary

    +
    + + +
    +

    Examples

    +
    # See the examples of the 'get.geotop.recovery.state' function
    +
    +
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/write.vectorized.variable.in.string.html b/docs/reference/write.vectorized.variable.in.string.html new file mode 100644 index 0000000..8500011 --- /dev/null +++ b/docs/reference/write.vectorized.variable.in.string.html @@ -0,0 +1,128 @@ + +Writes one or more variables (scalars, vectors or Rasters) in a string each, following *.inpts or Matlab-like syntax. — write.vectorized.variable.in.string • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    Writes one or more variables (scalars, vectors or Rasters) in a string each, following *.inpts or Matlab-like syntax.

    +
    + +
    +
    write.vectorized.variable.in.string(
    +  l,
    +  NAflag = -9999,
    +  matlab.syntax = FALSE,
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    l
    +

    a list object contained the variables (scalars, vectors or Rasters) which will be written in a string each.

    + + +
    NAflag
    +

    numeric. Default is -9999, see writeRasterxGEOtop.

    + + +
    matlab.syntax
    +

    logical value. Default is FALSE. If TRUE the file syntax is like the one of a *.m Matlab script file.

    + + +
    ...
    +

    further aguments

    + +
    +
    +

    Value

    +

    the string vector <NAME_VARIABLE>==<VALUES_VARIABLE>.

    +
    +
    +

    Note

    +

    Add Quote if necessary

    +
    + + +
    +

    Examples

    +
    a <- 1:5
    +l <- list(v=a,a=a)
    +out <- write.vectorized.variable.in.string(l,matlab.syntax=TRUE)
    +out 
    +#> [1] "v=[1,2,3,4,5]" "a=[1,2,3,4,5]"
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/writeRasterxGEOtop.html b/docs/reference/writeRasterxGEOtop.html new file mode 100644 index 0000000..7c46fca --- /dev/null +++ b/docs/reference/writeRasterxGEOtop.html @@ -0,0 +1,157 @@ + +This function uses writeRaster to create .asc maps which can be read by GEOtop — writeRasterxGEOtop • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    This function uses writeRaster to create .asc maps which can be read by GEOtop

    +
    + +
    +
    writeRasterxGEOtop(
    +  x,
    +  filename = NULL,
    +  overwrite = TRUE,
    +  NAflag = -9999,
    +  use.decimal.formatter = FALSE,
    +  start.from.zero = FALSE,
    +  keyword,
    +  wpath,
    +  suffix.ext = ".asc",
    +  ...
    +)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    a Raster object, see writeRaster. It can be also a RasterBrick-class object.

    + + +
    filename
    +

    see writeRaster. It is a vector of string or one string containing a decimal formatter (see brick.decimal.formatter) in case x is a RasterBrick-class object.

    + + +
    overwrite
    +

    logical. Default is TRUE, see writeRaster.

    + + +
    NAflag
    +

    numeric. Dafauli is -9999, see writeRaster.

    + + +
    use.decimal.formatter
    +

    logical value. Default is FALSE. If it is TRUE or x is a RasterBrick-class object with nlayers(x)!=length(filename) , filename is considered as one string containing a decimal formatter (e.g. "%04d", see brick.decimal.formatter). Otherwise, if filename is considered as a vector string.

    + + +
    start.from.zero
    +

    logical value. Default is FALSE. If TRUE the formatter starts from 0000, otherwise it starts from 0001.

    + + +
    keyword
    +

    geotop keyword to be used to extract the raster file name from geotop.inpts file. This is enabled if filename is equal to NULL.

    + + +
    wpath
    +

    simulation folder containing geotop.inpts file.

    + + +
    suffix.ext
    +

    charachter string to be added to the keyword value,e.g. possible suffix and extension of the raster file name. Default is ".asc".

    + + +
    ...
    +

    further arguments of get.geotop.inpts.keyword.value or writeRaster

    + +
    +
    +

    Note

    +

    It makes use of system functons. It uses *.asc format for raster files. + In case the file name filename is missing and then NULL, it must be imported by the simulation geotop.inpts file.

    +
    + +
    +

    Examples

    +
    
    +
    +file <- system.file("ex/elev.tif", package="terra")
    +elev <- raster(file)
    +
    +
    +elevfile <- rasterTmpFile()
    +extension(elevfile) <- ".asc"
    +
    +writeRasterxGEOtop(x=elev,file=elevfile)
    +
    +
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/zoo-class.html b/docs/reference/zoo-class.html new file mode 100644 index 0000000..811eafd --- /dev/null +++ b/docs/reference/zoo-class.html @@ -0,0 +1,90 @@ + +A GeotopRasterBrick: an object to manage raster maps provied by GEOtop!! — zoo-class • geotopbricks + + +
    +
    + + + +
    +
    + + +
    +

    A GeotopRasterBrick: an object to manage raster maps provied by GEOtop!!

    +
    + + + +
    +

    Examples

    +
    showClass("zoo")
    +#> Virtual Class "zoo" [package "geotopbricks"]
    +#> 
    +#> Slots:
    +#>                 
    +#> Name:   .S3Class
    +#> Class: character
    +#> 
    +#> Extends: "oldClass"
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..b6fb3cd --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,41 @@ + +/404.html +/LICENSE-text.html +/authors.html +/index.html +/reference/GeotopRasterBrick-class.html +/reference/KML-methods.html +/reference/Ops-methods.html +/reference/argsParser.html +/reference/bondone.html +/reference/brick-methods.html +/reference/brick.decimal.formatter.html +/reference/brickFromOutputSoil3DTensor.html +/reference/create.geotop.inpts.keyword.html +/reference/create.geotop.meteo.files.html +/reference/declared.geotop.inpts.keywords.html +/reference/geotopbrick.html +/reference/get.geotop.inpts.keyword.value.html +/reference/get.geotop.points.html +/reference/get.geotop.recovery.state.html +/reference/getProjection.html +/reference/getvalues.brick.at.depth.html +/reference/index.html +/reference/max_value.html +/reference/min_value.html +/reference/plot-methods.html +/reference/pointer.to.maps.xyz.time.html +/reference/read.ascii.vectorized.brick.html +/reference/read.raster.from.url.html +/reference/read.vectorized.geotop.recovery.html +/reference/replace.keyword.html +/reference/set.geotop.recovery.state.html +/reference/vertical.aggregate.brick.within.depth.html +/reference/write.ascii.vectorized.brick.html +/reference/write.geotop.table.html +/reference/write.vectorized.geotop.recovery.html +/reference/write.vectorized.variable.in.string.html +/reference/writeRasterxGEOtop.html +/reference/zoo-class.html + + diff --git a/inst/additional_files/build_website.R b/inst/additional_files/build_website.R index ac2ea54..9380b93 100644 --- a/inst/additional_files/build_website.R +++ b/inst/additional_files/build_website.R @@ -2,5 +2,5 @@ library(pkgdown) #### pkg ="/home/ecor/local/rpackages/rendena100/geotopbricks" -###pkgdown::clean_site(pkg=pkg) -pkgdown::build_site(pkg=pkg) ##,override = list(destination = destination_site)) \ No newline at end of file + +pkgdown::build_site(pkg=pkg) diff --git a/inst/sticker/sticker_geotopbricks_v2_prov_.png b/inst/sticker/sticker_geotopbricks_v2_prov_.png index 813f7ae..d6ab155 100644 Binary files a/inst/sticker/sticker_geotopbricks_v2_prov_.png and b/inst/sticker/sticker_geotopbricks_v2_prov_.png differ